Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct errors in WalkDir type docs #32

Closed
KodrAus opened this issue Jun 14, 2017 · 3 comments
Closed

Correct errors in WalkDir type docs #32

KodrAus opened this issue Jun 14, 2017 · 3 comments

Comments

@KodrAus
Copy link
Contributor

KodrAus commented Jun 14, 2017

The docs on WalkDir have a few inaccuracies about the behaviour that should be corrected:

  • If contents_first is true, then directories aren't emitted before their contents
  • The order isn't unspecified if a sort_by function is given. Or does 'unspecified' mean something different here?
@alisha17
Copy link
Contributor

alisha17 commented Jul 8, 2017

I can fix this. Where this has to be fixed in the docs?

@KodrAus
Copy link
Contributor Author

KodrAus commented Jul 8, 2017

Thanks @alisha17!

See this paragraph in the docs for WalkDir.

They state that directories are always emitted before the contents, and that using sort_by means the items will be emitted according to that ordering.

Let me know if you need any more details.

@BurntSushi
Copy link
Owner

Fixed by #74

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants