Tracking issue for libz blitz evaluation of walkdir

[KodrAus]

This is the tracking issue for the evaluation performed by the libs team this week.

• Add Error docs to methods that return Result

• Use ? in docs instead of unwrapping

• Add example for content_first

• Add links to other walkdir items in DirEntry docs

• Add links to other walkdir items in Iter and IterFilterEntry docs

• Add links to other walkdir items in WalkDir docs

• Add links to other walkdir items in WalkDirIterator docs

• Document that Iter and IterFilterEntry are the result of trait methods

• Correct errors in WalkDir type docs

• Add html_root_url attribute

• Implement Debug for WalkDir, Iter and IterFilterEntry

• Add build badges to Cargo.toml

• Add categories to Cargo.toml

• Rename Iter to IntoIter

• Rename IterFilterEntry to FilterEntry

• Link references to std in docs

• Make skip_current_dir and filter_entry inherent methods

• Make WalkDir Send + Sync

• Document why unwraps won't fail

• Remove re-export of is_same_file

• Move DirEntry::ino method to an extension trait

• Implement Clone for WalkDir

[KodrAus]

I've added some PRs to a list of non-breaking changes so we can look at merging those in and doing a point-release before 2.0.

I'm not sure what strategy you had @BurntSushi for splitting the changes between breaking and non-breaking. Maybe we can do some git flow by making a 1.x branch and merge the non-breaking changes into that.

EDIT: Alternatively we could just not worry about breaking/non-breaking and pool everything up for 2.0.

[BurntSushi]

EDIT: Alternatively we could just not worry about breaking/non-breaking and pool everything up for 2.0.

Yes, I'd prefer this route. Let's not do more work than we need to. :-)

If need be, we can branch off of the 1.0.7 tag (which is currently the most recent release of 1.x) in the future if we need or want to backport any fixes from 2.x.

[KodrAus]

I've updated the OP, looks like we've got open PRs for all issues except #54, and more design work in #53 🎉 Awesome work everyone and thanks for contributing!