Add docs

Remove 2 unnecessary comments

Author: cruessler

gix-diff/src/blob/unified_diff.rs

@@ -68,12 +68,15 @@ pub enum NewlineSeparator<'a> {
     AfterHeaderAndWhenNeeded(&'a str),
 }
 
-/// TODO:
-/// Document.
+/// Holds information about a unified diff hunk, specifically with respect to line numbers.
 pub struct HunkHeader {
+    /// The 1-based start position in the 'before' lines.
     before_hunk_start: u32,
+    /// The size of the 'before' hunk in lines.
     before_hunk_len: u32,
+    /// The 1-based start position in the 'after' lines.
     after_hunk_start: u32,
+    /// The size of the 'after' hunk in lines.
     after_hunk_len: u32,
 }
 
@@ -89,15 +92,14 @@ impl std::fmt::Display for HunkHeader {
 
 /// A utility trait for use in [`UnifiedDiffSink`](super::UnifiedDiffSink).
 pub trait ConsumeTypedHunk {
-    /// TODO:
-    /// Document.
+    /// The item this instance produces after consuming all hunks.
     type Out;
 
-    /// TODO:
-    /// Document.
-    /// How do we want to pass the header to `consume_hunk`? We can add an additional parameter
-    /// similar to `ConsumeHunk::consume_hunk` or add `DiffLineType::Header` in which case we
-    /// didn’t have to add an additional parameter.
+    /// Consume a single hunk.
+    ///
+    /// Note that the [`UnifiedDiffSink`](super::UnifiedDiffSink) sink will wrap its output in a
+    /// [`std::io::Result`]. After this method returned its first error, it will not be called
+    /// again.
     fn consume_hunk(&mut self, header: HunkHeader, lines: &[(DiffLineType, &[u8])]) -> std::io::Result<()>;
 
     /// Called when processing is complete.
@@ -224,10 +226,6 @@ pub(super) mod _impl {
             let hunk_start = self.before_hunk_start + 1;
             let hunk_end = self.after_hunk_start + 1;
 
-            // TODO:
-            // Is this explicit conversion necessary?
-            // Is the comment necessary?
-            // Convert Vec<(DiffLineType, Vec<u8>)> to Vec<(DiffLineType, &[u8])>
             let lines: Vec<(DiffLineType, &[u8])> = self
                 .buffer
                 .iter()
@@ -458,8 +456,6 @@ pub(super) mod _impl {
 
             for &(line_type, content) in lines {
                 self.push(line_type.to_prefix());
-                // TODO:
-                // How does `impl ConsumeHunk for String` handle errors?
                 self.push_str(std::str::from_utf8(content).map_err(|e| std::io::Error::new(ErrorKind::Other, e))?);
                 self.push('\n');
             }