Add some comments about the node split method

videni · Dec 20, 2024 · cc0c227 · cc0c227
1 parent 0daa403
commit cc0c227
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/examples/text.rs b/examples/text.rs
@@ -14,9 +14,9 @@ fn main() {
             for line in run.lines {
                 for word in line.words {
                     println!("{}", word.text.as_str());
-                    for char in word.chars {
-                        println!("{:?}", char);
-                    }
+                    // for char in word.chars {
+                    //     println!("{:?}", char);
+                    // }
                 }
             }
         }

diff --git a/src/node.rs b/src/node.rs
@@ -201,8 +201,11 @@ fn split<E: Encoder>(boxes: &mut [(RectF, usize)], spans: &[TextSpan<E>], lines:
     }
 
     let tag = match (y_gaps.is_empty(), x_gaps.is_empty()) {
+        // N y gaps, whatever x_gap is, if cells are all lines, then it is a line
         (true, _) if cells.iter().all(|n| n.tag() <= NodeTag::Line) => NodeTag::Line,
+        // N x gaps, whatever y_gap is, if cells are all lines, then it is a paragraph
         (_, true) if cells.iter().all(|n| n.tag() <= NodeTag::Line) => NodeTag::Paragraph,
+        // Otherwise it is a complex node
         _ => NodeTag::Complex
     };