Fix and improve documentation

Author: mangelats

soa-derive-internal/src/slice.rs

@@ -177,7 +177,7 @@ pub fn derive(input: &Input) -> TokenStream {
             /// Similar to [`std::ops::Index` trait](https://doc.rust-lang.org/std/ops/trait.Index.html) on
             #[doc = #slice_name_str]
             /// .
-            /// This is required because we cannot implement that trait.
+            /// This is required because we cannot implement `std::ops::Index` directly since it requires returning a reference.
             pub fn index<'b, I>(&'b self, index: I) -> I::RefOutput
             where
                 I: ::soa_derive::SoAIndex<#slice_name<'b>>,
@@ -187,7 +187,7 @@ pub fn derive(input: &Input) -> TokenStream {
                 index.index(slice)
             }
 
-            /// Reborrows the slices in a more narrower lifetime
+            /// Reborrows the slices in a narrower lifetime
             pub fn reborrow<'b>(&'b self) -> #slice_name<'b>
             where
                 'a: 'b
@@ -468,7 +468,7 @@ pub fn derive_mut(input: &Input) -> TokenStream {
             /// Similar to [`std::ops::IndexMut` trait](https://doc.rust-lang.org/std/ops/trait.IndexMut.html) on
             #[doc = #slice_name_str]
             /// .
-            /// This is required because we cannot implement that trait.
+            /// This is required because we cannot implement `std::ops::IndexMut` directly since it requires returning a mutable reference.
             pub fn index_mut<'b, I>(&'b mut self, index: I) -> I::MutOutput
             where
                 I: ::soa_derive::SoAIndexMut<#slice_mut_name<'b>>,
@@ -488,7 +488,7 @@ pub fn derive_mut(input: &Input) -> TokenStream {
                 }
             }
 
-            /// Reborrows the slices in a more narrower lifetime
+            /// Reborrows the slices in a narrower lifetime
             pub fn reborrow<'b>(&'b mut self) -> #slice_mut_name<'b>
             where
                 'a: 'b

src/lib.rs

@@ -193,23 +193,23 @@ pub trait SoAIndex<T>: private_soa_indexs::Sealed {
     /// The output for the non-mutable functions
     type RefOutput;
 
-    /// Returns the reference output in this location if in bounds. None otherwise.
+    /// Returns the reference output in this location if in bounds, `None` otherwise.
     fn get(self, soa: T) -> Option<Self::RefOutput>;
-    /// Returns the reference output in this location withotu performing any bounds check.
+    /// Returns the reference output in this location without performing any bounds check.
     unsafe fn get_unchecked(self, soa: T) -> Self::RefOutput;
     /// Returns the reference output in this location. Panics if it is not in bounds.
     fn index(self, soa: T) -> Self::RefOutput;
 }
 
-/// Helper trait used for indexing operations returning mutable.
+/// Helper trait used for indexing operations returning mutable references.
 /// Inspired by [`std::slice::SliceIndex`](https://doc.rust-lang.org/std/slice/trait.SliceIndex.html).
 pub trait SoAIndexMut<T>: private_soa_indexs::Sealed {
     /// The output for the mutable functions
     type MutOutput;
 
-    /// Returns the mutable reference output in this location if in bounds. None otherwise.
+    /// Returns the mutable reference output in this location if in bounds, `None` otherwise.
     fn get_mut(self, soa: T) -> Option<Self::MutOutput>;
-    /// Returns the mutable reference output in this location withotu performing any bounds check.
+    /// Returns the mutable reference output in this location without performing any bounds check.
     unsafe fn get_unchecked_mut(self, soa: T) -> Self::MutOutput;
     /// Returns the mutable reference output in this location. Panics if it is not in bounds.
     fn index_mut(self, soa: T) -> Self::MutOutput;