Document why unwraps won't fail

BurntSushi / walkdir

Rust library for walking directories recursively.

The Unlicense

1.24k stars 107 forks source link

Document why unwraps won't fail #42

Closed KodrAus closed 7 years ago

KodrAus commented 7 years ago

We should add some inline comments to the few calls to unwrap so it's clear to readers why it's safe to call unwrap in those places. All unwraps:

[ ] <Iter as Iterator>::next
[ ] Iter::get_deferred_dir
[ ] Iter::push

We might also want to change these to expects with a simple message that the panic is a bug in walkdir.

shssoichiro commented 7 years ago

I'd like to work on this issue.