Skip to content

Commit b8a7b6e

Browse files
committed
Simplify MDBook::iter doc
The original was a little awkward, and I'm not sure what the tuple syntax was intending to convey.
1 parent 9229e80 commit b8a7b6e

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

crates/mdbook-driver/src/mdbook.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,7 @@ impl MDBook {
134134
})
135135
}
136136

137-
/// Returns a flat depth-first iterator over the elements of the book,
138-
/// it returns a [`BookItem`] enum:
139-
/// `(section: String, bookitem: &BookItem)`
137+
/// Returns a flat depth-first iterator over the [`BookItem`]s of the book.
140138
///
141139
/// ```no_run
142140
/// # use mdbook_driver::MDBook;

0 commit comments

Comments
 (0)