diff options
author | Andrew Gallant <jamslam@gmail.com> | 2017-10-22 01:54:21 +0300 |
---|---|---|
committer | Andrew Gallant <jamslam@gmail.com> | 2017-10-22 01:54:21 +0300 |
commit | 286bb1f3aad4e22173c5b7ba87eb30ca2c3afe6a (patch) | |
tree | 8085472008acbba0a022be425d83b6ee28dd444d | |
parent | a9f41405c0fac03d0119c6cbfc38443040cd53ea (diff) |
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.
-rw-r--r-- | src/lib.rs | 7 |
1 files changed, 4 insertions, 3 deletions
@@ -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. |