mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rework Path::ancestors documentation to remove unwraps

Browse Source 
If you take a quick glance at the documentation for Path::ancestors, the unwraps take the natural focus. Potentially indicating that ancestors might panic.
In the reworked version I've also moved the link with parent returning None and that the iterator will always yield &self to before the yield examples.
This commit is contained in:
Kriskras99 2024-04-10 13:43:36 +02:00 committed by GitHub
parent bc8ad6a41e
commit 6b0d3663c1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
library/std/src/path.rs
View File

@ -2278,10 +2278,9 @@ impl Path {
/// Produces an iterator over `Path` and its ancestors. /// Produces an iterator over `Path` and its ancestors.
/// ///
/// The iterator will yield the `Path` that is returned if the [`parent`] method is used zero /// The iterator will yield the `Path` that is returned if the [`parent`] method is used zero
/// or more times. That means, the iterator will yield `&self`, `&self.parent().unwrap()`, /// or more times. If the [`parent`] method returns [`None`], the iterator will do likewise.
/// `&self.parent().unwrap().parent().unwrap()` and so on. If the [`parent`] method returns /// The iterator will always yield at least one value, namely `Some(&self)`. Next it will yield
/// [`None`], the iterator will do likewise. The iterator will always yield at least one value, /// `&self.parent()`, `&self.parent().and_then(Path::parent)` and so on.
/// namely `&self`.
/// ///
/// # Examples /// # Examples
/// ///