Add field docstrings for Hunk

2022-02-12 12:31:21 +07:00 · 2022-02-12 12:31:21 +07:00 · 043395a8c5
parent 84a2dc2dac
commit 043395a8c5
1 changed files with 4 additions and 0 deletions
--- a/src/hunks.rs
+++ b/src/hunks.rs
@ -18,8 +18,12 @@ use crate::{
 /// together.
 #[derive(Debug, Clone)]
 pub struct Hunk {
+    /// The LHS line numbers that contain novel content.
    pub novel_lhs: HashSet<LineNumber>,
+    /// The RHS line numbers that contain novel content.
    pub novel_rhs: HashSet<LineNumber>,
+    /// Line pairs that contain modified lines. This does not include
+    /// padding, so at least one of the two lines has novel content.
    pub lines: Vec<(Option<LineNumber>, Option<LineNumber>)>,
 }