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

Jump to bottom

home: fix & enhance documentation #12047

Merged
merged 2 commits into from
Apr 27, 2023
Merged

home: fix & enhance documentation #12047

merged 2 commits into from
Apr 27, 2023

Conversation

utkarshgupta137
Copy link
Contributor

What does this PR try to resolve?

Fixes the documentation to specify that the HOME environment variable will be returned on Unix even if it is empty.
Also cleaned up & improved documentation in other areas.

Additional information

Related: #12023

@rustbot
Copy link
Collaborator

rustbot commented Apr 27, 2023

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @weihanglo (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbot rustbot added A-environment-variables Area: environment variables S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 27, 2023
weihanglo
weihanglo reviewed Apr 27, 2023
View reviewed changes
Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Looks good.

crates/home/src/lib.rs Outdated
Comment on lines 19 to 20
//! See also the [`dirs`](https://docs.rs/dirs) crate.
//!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Cargo project usually avoids mentioning a specific crate in its documentation. I would recommend removing these.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Could you also bump the crate version to 0.5.6? We might not make a release right away though.

Copy link
Contributor Author

@utkarshgupta137 utkarshgupta137 Apr 27, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. but it also increased the version in workspace Cargo.lock, not sure if it matters

@weihanglo
Copy link
Member

Thank you!

@bors r+

@bors
Copy link
Collaborator

bors commented Apr 27, 2023

📌 Commit fd1f104 has been approved by weihanglo

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 27, 2023
@bors
Copy link
Collaborator

bors commented Apr 27, 2023

⌛ Testing commit fd1f104 with merge 923d530...

@utkarshgupta137
Copy link
Contributor Author

utkarshgupta137 commented Apr 27, 2023 •
edited
Loading

One thing I forgot to mention:

  • For Unix, if the HOME variable is empty, then an empty path is returned.
  • For Windows, if the USERPROFILE is empty, then it still falls back to the OS API.

I personally think this crate should be consistent regarding this. My PR #12023 was about fixing the behavior for Unix but was closed on the grounds that this is what Go & Python do. I think that on the same basis, if the USERPROFILE variable is empty, an empty path should be returned on Windows too.

Edit: To be clear, I would prefer if #12023 was merged.

@bors
Copy link
Collaborator

bors commented Apr 27, 2023

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 923d530 to master...

@bors bors merged commit 923d530 into rust-lang:master Apr 27, 2023
@weihanglo weihanglo mentioned this pull request May 2, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request May 3, 2023
@bors
Auto merge of rust-lang#111107 - weihanglo:update-cargo, r=weihanglo
cad92b4 
Update cargo

16 commits in 9e586fbd8b931494067144623b76c37d213b1ab6..ac84010322a31f4a581dafe26258aa4ac8dea9cd
2023-04-25 22:09:11 +0000 to 2023-05-02 13:41:16 +0000
- docs(registry): Further specify owner-remove response (rust-lang/cargo#12056) (rust-lang/cargo#12068)
- Remove repeated definite articles (rust-lang/cargo#12067)
- Document that adding `#[non_exhaustive]` on existing items is breaking. (rust-lang/cargo#10877)
- docs(commands): add missed preposition (rust-lang/cargo#12073)
- Fix warning with unused mut (rust-lang/cargo#12065)
- chore: move build-man workflow away from shell (rust-lang/cargo#12048)
- feat: Add `-Zmsrv-policy` feature flag (rust-lang/cargo#12043)
- chore: new xtask to check stale paths in autolabel defintions (rust-lang/cargo#12051)
- cargo-tree: Handle -e no-proc-macro when building the graph (rust-lang/cargo#12044)
- chore: update trigger_files in autolabel (rust-lang/cargo#12052)
- fix broken markdown in docs (rust-lang/cargo#12049)
- home: fix & enhance documentation (rust-lang/cargo#12047)
- chore: Mark unpublished crates as such (rust-lang/cargo#12045)
- Include rust-version in publish request (rust-lang/cargo#12041)
- chore(xtask): Add `cargo xtask unpublished` (rust-lang/cargo#12039)
- docs(ref): Specify 'rust_version' in Index format (rust-lang/cargo#12040)

r? `@ghost`
RalfJung pushed a commit to RalfJung/miri that referenced this pull request May 3, 2023
@bors
Auto merge of #111107 - weihanglo:update-cargo, r=weihanglo
a3fc118 
Update cargo

16 commits in 9e586fbd8b931494067144623b76c37d213b1ab6..ac84010322a31f4a581dafe26258aa4ac8dea9cd
2023-04-25 22:09:11 +0000 to 2023-05-02 13:41:16 +0000
- docs(registry): Further specify owner-remove response (rust-lang/cargo#12056) (rust-lang/cargo#12068)
- Remove repeated definite articles (rust-lang/cargo#12067)
- Document that adding `#[non_exhaustive]` on existing items is breaking. (rust-lang/cargo#10877)
- docs(commands): add missed preposition (rust-lang/cargo#12073)
- Fix warning with unused mut (rust-lang/cargo#12065)
- chore: move build-man workflow away from shell (rust-lang/cargo#12048)
- feat: Add `-Zmsrv-policy` feature flag (rust-lang/cargo#12043)
- chore: new xtask to check stale paths in autolabel defintions (rust-lang/cargo#12051)
- cargo-tree: Handle -e no-proc-macro when building the graph (rust-lang/cargo#12044)
- chore: update trigger_files in autolabel (rust-lang/cargo#12052)
- fix broken markdown in docs (rust-lang/cargo#12049)
- home: fix & enhance documentation (rust-lang/cargo#12047)
- chore: Mark unpublished crates as such (rust-lang/cargo#12045)
- Include rust-version in publish request (rust-lang/cargo#12041)
- chore(xtask): Add `cargo xtask unpublished` (rust-lang/cargo#12039)
- docs(ref): Specify 'rust_version' in Index format (rust-lang/cargo#12040)

r? `@ghost`
@ehuss ehuss added this to the 1.71.0 milestone May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weihanglo weihanglo weihanglo approved these changes

Assignees

@weihanglo weihanglo

Labels
A-environment-variables Area: environment variables S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.71.0
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@utkarshgupta137 @rustbot @weihanglo @bors @ehuss