Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/windirstat/walkdir.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Lamparski <diagonaldevice@gmail.com>2018-02-10 21:35:49 +0300
committerAndrew Gallant <jamslam@gmail.com>2018-02-10 21:35:49 +0300
commit44a5dfe6f7a64ec2d8685e8d2b2409a55b7902d5 (patch)
tree9eeeff8ab468ef2b4705e5715c9f718c028bcb01
parentaa8b1544f5576ed663ae79085c6f057dd7470729 (diff)
doc: improve stdout in contents_first example
A big potential question on the reader's mind when reviewing these docs is "what will the paths returned by the iterator be relative to?" This is the one example on the page which shows output that could potentially answer that question, and to only see filenames is needlessly discouraging.
-rw-r--r--src/lib.rs16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 29df0c9..3a1df69 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -423,10 +423,10 @@ impl WalkDir {
/// }
///
/// // foo
- /// // abc
- /// // qrs
- /// // tuv
- /// // def
+ /// // foo/abc
+ /// // foo/abc/qrs
+ /// // foo/abc/tuv
+ /// // foo/def
/// ```
///
/// With contents_first enabled:
@@ -439,10 +439,10 @@ impl WalkDir {
/// println!("{}", entry.path().display());
/// }
///
- /// // qrs
- /// // tuv
- /// // abc
- /// // def
+ /// // foo/abc/qrs
+ /// // foo/abc/tuv
+ /// // foo/abc
+ /// // foo/def
/// // foo
/// ```
pub fn contents_first(mut self, yes: bool) -> Self {