Update comments to follow project style

aacuevas · jonnew · commit d43303c9d471 · 2025-06-19T10:23:28.000-04:00
diff --git a/OpenEphys.Onix1/PolledBno055Data.cs b/OpenEphys.Onix1/PolledBno055Data.cs
@@ -115,7 +115,7 @@ public unsafe IObservable<Bno055DataFrame> Generate<TSource>(IObservable<TSource
                                 registeredValues.Add(deviceName);
                             }
 
-                            // Preallocate the array to avoid unnecesary allocation each frame
+                            // NB: Preallocate the array to avoid unnecesary allocation each frame
                             byte[] data = new byte[28];
                             var s = source.SubscribeSafe(observer, _ =>
                             {
@@ -162,7 +162,7 @@ public unsafe IObservable<Bno055DataFrame> Generate<TSource>(IObservable<TSource
                                           Array.Clear(data, 0, 6);
                                       }
 
-                                      //NOTE: actual performance would be a little better if we merged these two so they could be read together
+                                      //TODO: actual performance would be a little better if we merged these two so they could be read together
                                       data[26] = polled.HasFlag(PolledBno055Registers.Temperature) ? i2c.ReadByte(PolledBno055.EulerHeadingLsbAddress + 26) : (byte)0;
                                       data[27] = polled.HasFlag(PolledBno055Registers.Calibration) ? i2c.ReadByte(PolledBno055.EulerHeadingLsbAddress + 27) : (byte)0;
 

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ public unsafe IObservable<Bno055DataFrame> Generate<TSource>(IObservable<TSource`
`115`	`115`	`registeredValues.Add(deviceName);`
`116`	`116`	`}`
`117`	`117`
`118`		`- // Preallocate the array to avoid unnecesary allocation each frame`
	`118`	`+ // NB: Preallocate the array to avoid unnecesary allocation each frame`
`119`	`119`	`byte[] data = new byte[28];`
`120`	`120`	`var s = source.SubscribeSafe(observer, _ =>`
`121`	`121`	`{`
`@@ -162,7 +162,7 @@ public unsafe IObservable<Bno055DataFrame> Generate<TSource>(IObservable<TSource`
`162`	`162`	`Array.Clear(data, 0, 6);`
`163`	`163`	`}`
`164`	`164`
`165`		`- //NOTE: actual performance would be a little better if we merged these two so they could be read together`
	`165`	`+ //TODO: actual performance would be a little better if we merged these two so they could be read together`
`166`	`166`	`data[26] = polled.HasFlag(PolledBno055Registers.Temperature) ? i2c.ReadByte(PolledBno055.EulerHeadingLsbAddress + 26) : (byte)0;`
`167`	`167`	`data[27] = polled.HasFlag(PolledBno055Registers.Calibration) ? i2c.ReadByte(PolledBno055.EulerHeadingLsbAddress + 27) : (byte)0;`
`168`	`168`