docs: move TODOs out of public doc strings (#1780)

vortex-file/src/read/builder/initial_read.rs

@@ -12,8 +12,8 @@ use crate::{LazyDType, EOF_SIZE, INITIAL_READ_SIZE, MAGIC_BYTES, VERSION};
 pub struct InitialRead {
     /// The bytes from the initial read of the file, which is assumed (for now) to be sufficiently
     /// large to contain the schema and layout.
-    /// TODO(ngates): we should ensure the initial read, and therefore the flatbuffers, are
-    ///  8-byte aligned. But the writer doesn't guarantee this right now.
+    // TODO(ngates): we should ensure the initial read, and therefore the flatbuffers, are
+    //  8-byte aligned. But the writer doesn't guarantee this right now.
     pub buf: ConstBuffer<u8, 1>,
     /// The absolute byte offset representing the start of the initial read within the file.
     pub initial_read_offset: u64,

vortex-ipc/src/messages/decoder.rs

@@ -88,12 +88,11 @@ pub enum PollRead {
     NeedMore(usize),
 }
 
+// NOTE(ngates): we should design some trait that the Decoder can take that doesn't require unique
+//  ownership of the underlying bytes. The decoder needs to split out bytes, and advance a cursor,
+//  but it doesn't need to mutate any bytes. So in theory, we should be able to do this zero-copy
+//  over a shared buffer of bytes, instead of requiring a `BytesMut`.
 /// A stateful reader for decoding IPC messages from an arbitrary stream of bytes.
-///
-/// NOTE(ngates): we should design some trait that the Decoder can take that doesn't require unique
-///  ownership of the underlying bytes. The decoder needs to split out bytes, and advance a cursor,
-///  but it doesn't need to mutate any bytes. So in theory, we should be able to do this zero-copy
-///  over a shared buffer of bytes, instead of requiring a `BytesMut`.
 pub struct MessageDecoder {
     /// The minimum alignment to use when reading a data `Buffer`.
     alignment: Alignment,