doc: formatting

Doc strings on public items should always start with a short one
sentence description. This is for readability purposes, and also to make
the display reasonable in rustdoc.

1 files changed, 4 insertions, 3 deletions

diff --git a/src/lib.rs b/src/lib.rs
index ebb0252..9289714 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1116,9 +1116,10 @@ impl fmt::Debug for DirEntry {
     }
 }
 
-/// A recursive directory iterator that skips entries. Returned by calling
-/// [`.filter_entry()`] on an `IntoIter`, which is formed by calling
-/// [`.into_iter()`] on a `WalkDir`.
+/// A recursive directory iterator that skips entries.
+///
+/// Values of this type are created by calling [`.filter_entry()`] on an
+/// `IntoIter`, which is formed by calling [`.into_iter()`] on a `WalkDir`.
 ///
 /// Directories that fail the predicate `P` are skipped. Namely, they are
 /// never yielded and never descended into.