strings: EqStrUntilNul: better documentation and code comments

Author: phip1611

uefi/src/data_types/strs.rs

@@ -147,7 +147,8 @@ impl<StrType: AsRef<str> + ?Sized> EqStrUntilNul<StrType> for CStr8 {
             .copied()
             .map(char::from)
             .zip(other.chars())
-            // this only works as CStr8 is guaranteed to have a fixed character length
+            // This only works as CStr8 is guaranteed to have a fixed character length
+            // (unlike UTF-8).
             .take_while(|(l, r)| *l != '\0' && *r != '\0')
             .any(|(l, r)| l != r);
 
@@ -354,7 +355,8 @@ impl<StrType: AsRef<str> + ?Sized> EqStrUntilNul<StrType> for CStr16 {
             .copied()
             .map(char::from)
             .zip(other.chars())
-            // this only works as CStr16 is guaranteed to have a fixed character length
+            // This only works as CStr16 is guaranteed to have a fixed character length
+            // (unlike UTF-8 or UTF-16).
             .take_while(|(l, r)| *l != '\0' && *r != '\0')
             .any(|(l, r)| l != r);
 
@@ -419,7 +421,8 @@ impl<'a> UnalignedSlice<'a, u16> {
 /// The EqStrUntilNul trait helps to compare Rust strings against UEFI string types (UCS-2 strings).
 /// The given generic implementation of this trait enables us that we only have to
 /// implement one direction (`left.eq_str_until_nul(&right)`) for each UEFI string type and we
-/// get the other direction (`right.eq_str_until_nul(&left)`) for free.
+/// get the other direction (`right.eq_str_until_nul(&left)`) for free. Hence, the relation is
+/// reflexive.
 pub trait EqStrUntilNul<StrType: ?Sized> {
     /// Checks if the provided Rust string `StrType` is equal to [Self] until the first null-byte
     /// is found. An exception is the terminating null-byte of [Self] which is ignored.