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.

Sign up for GitHub

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

Update documentation of Path::to_path_buf and Path::ancestors #123716

Merged
merged 2 commits into from
Apr 13, 2024
Merged

Update documentation of Path::to_path_buf and Path::ancestors #123716

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc8ad6a
Bring documentation of Path::to_path_buf in line with the rest of Pat…
Kriskras99 Apr 10, 2024
6b0d366
Rework Path::ancestors documentation to remove unwraps
Kriskras99 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Rework Path::ancestors documentation to remove unwraps 
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.
  • Loading branch information
@Kriskras99
Kriskras99 authored Apr 10, 2024
commit 6b0d3663c1be68a0f5a619c00e946b0754d7c3a8
7 changes: 3 additions & 4 deletions library/std/src/path.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2278,10 +2278,9 @@ impl Path {
/// Produces an iterator over `Path` and its ancestors.
///
/// 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()`,
/// `&self.parent().unwrap().parent().unwrap()` and so on. If the [`parent`] method returns
/// [`None`], the iterator will do likewise. The iterator will always yield at least one value,
/// namely `&self`.
/// or more times. If the [`parent`] method returns [`None`], the iterator will do likewise.
/// The iterator will always yield at least one value, namely `Some(&self)`. Next it will yield
/// `&self.parent()`, `&self.parent().and_then(Path::parent)` and so on.
///
/// # Examples
///
Expand Down
Loading