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

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

merged 2 commits into from
Apr 13, 2024

Conversation

Kriskras99
Copy link
Contributor

@Kriskras99 Kriskras99 commented Apr 10, 2024

Path::to_path_buf

Changes the example from using the qualified path of PathBuf with an import. This is what's done in all other Path/PathBuf examples and makes the code look a bit cleaner.

Path::ancestors

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.

Feel free to cherry-pick the changes you like.

…h/PathBuf

Changes the example from using the qualified path of PathBuf with an import. This is what's done in all other Path/PathBuf examples and makes the code look a bit cleaner.
@rustbot
Copy link
Collaborator

rustbot commented Apr 10, 2024

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Apr 10, 2024
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.
@Kriskras99 Kriskras99 changed the title Bring documentation of Path::to_path_buf in line with the rest of Path/PathBuf Update documentation of Path::to_path_buf and Path::ancestors Apr 10, 2024
@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 13, 2024

📌 Commit 6b0d366 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 13, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 13, 2024
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#123530 (Enable building tier2 target riscv32im-unknown-none-elf)
 - rust-lang#123642 (do not allow using local llvm while using rustc from ci)
 - rust-lang#123716 (Update documentation of Path::to_path_buf and Path::ancestors)
 - rust-lang#123876 (Update backtrace submodule)
 - rust-lang#123888 (Replace a `DefiningOpaqueTypes::No` with `Yes` by asserting that one side of the comparison is a type variable.)
 - rust-lang#123890 (removed (mostly) unused code)
 - rust-lang#123891 (Miri subtree update)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit c5bf34a into rust-lang:master Apr 13, 2024
11 checks passed
@rustbot rustbot added this to the 1.79.0 milestone Apr 13, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Apr 13, 2024
Rollup merge of rust-lang#123716 - Kriskras99:patch-2, r=Mark-Simulacrum

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

`Path::to_path_buf`
> Changes the example from using the qualified path of PathBuf with an import. This is what's done in all other Path/PathBuf examples and makes the code look a bit cleaner.

`Path::ancestors`
> 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.

Feel free to cherry-pick the changes you like.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants