Skip to content

Add doc aliases to fs.rs #86839

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
Merged
merged 1 commit into from
Jul 29, 2021
Merged

Add doc aliases to fs.rs #86839

merged 1 commit into from
Jul 29, 2021

Conversation

D1mon
Copy link
Contributor

@D1mon D1mon commented Jul 3, 2021

Add aliases for create_dir, create_dir_all, remove_dir, remove_dir_all

@rust-highfive
Copy link
Contributor

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

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 3, 2021
@the8472
Copy link
Member

the8472 commented Jul 4, 2021

The libs team is currently working on a policy when doc aliases are appropriate. rust-lang/std-dev-guide#25
Some of the proposals here would not be in line with that policy.

@bors
Copy link
Collaborator

bors commented Jul 5, 2021

☔ The latest upstream changes (presumably #86891) made this pull request unmergeable. Please resolve the merge conflicts.

@joshtriplett
Copy link
Member

Based on the new doc alias policy, could you please drop the aliases for the _all variants, and drop the delete and rm aliases? Just keep the mkdir and rmdir aliases, and only for the function they directly map to (the non-_all) variant.

@jyn514 jyn514 changed the title Update fs.rs Add doc aliases to fs.rs Jul 8, 2021
@jyn514
Copy link
Member

jyn514 commented Jul 8, 2021

@D1mon can you squash the commits? We don't allow merge commits, there's instructions in the dev guide: https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy

@D1mon
Copy link
Contributor Author

D1mon commented Jul 10, 2021

I can't commit (merging is blocked). Maybe because i edit in github (without git clone)!?

@jyn514
Copy link
Member

jyn514 commented Jul 10, 2021

@bors squash (not sure if it works without an approval, but worth a shot)

@JohnCSimon JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 25, 2021
JohnTitor
JohnTitor approved these changes Jul 27, 2021
View reviewed changes
Copy link
Member

@JohnTitor JohnTitor left a comment

Choose a reason for hiding this comment

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

Let's go ahead with bors-squashed, that feature has some bugs but it should just work at least.
The change itself follows https://std-dev-guide.rust-lang.org/documentation/doc-alias-policy.html so LGTM.

@JohnTitor
Copy link
Member

r? @JohnTitor @bors r+ rollup

@bors
Copy link
Collaborator

bors commented Jul 27, 2021

📌 Commit 0efd350 has been approved by JohnTitor

@rust-highfive rust-highfive assigned JohnTitor and unassigned yaahc Jul 27, 2021
@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 Jul 27, 2021
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Jul 28, 2021
@JohnTitor
Rollup merge of rust-lang#86839 - D1mon:patch-1, r=JohnTitor
609bed8 
Add doc aliases to fs.rs

Add aliases for create_dir, create_dir_all, remove_dir, remove_dir_all
@JohnTitor JohnTitor mentioned this pull request Jul 28, 2021
Closed
@JohnTitor
Copy link
Member

@bors rollup-
A rollup doesn't handle the squash status, it seems: #87539

@D1mon @JohnTitor
Add some doc aliases
387cd6d 
Add `mkdir` to `create_dir`, `rmdir` to `remove_dir`.
@JohnTitor
Copy link
Member

Okay, I've squashed them on my local, everything should be fine now.
@bors r+ rollup squash-

@bors
Copy link
Collaborator

bors commented Jul 28, 2021

📌 Commit 387cd6d has been approved by JohnTitor

JohnTitor added a commit to JohnTitor/rust that referenced this pull request Jul 28, 2021
@JohnTitor
Rollup merge of rust-lang#86839 - D1mon:patch-1, r=JohnTitor
3e5e737 
Add doc aliases to fs.rs

Add aliases for create_dir, create_dir_all, remove_dir, remove_dir_all
This was referenced Jul 28, 2021
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 28, 2021
@bors
Auto merge of rust-lang#87569 - JohnTitor:rollup-7ydfetw, r=JohnTitor
4533be9 
Rollup of 10 pull requests

Successful merges:

 - rust-lang#81050 (Stabilize core::task::ready!)
 - rust-lang#81363 (Remove P: Unpin bound on impl Future for Pin)
 - rust-lang#86839 (Add doc aliases to fs.rs)
 - rust-lang#87435 (fix example code for E0617)
 - rust-lang#87451 (Add support for tuple struct field documentation)
 - rust-lang#87491 (Integrate context into the memorial to Anna)
 - rust-lang#87521 (Add long explanation for E0498)
 - rust-lang#87527 (Don't run MIR unsafeck at all when using `-Zthir-unsafeck`)
 - rust-lang#87550 (Add `CI_ONLY_WHEN_CHANNEL` and run `x86_64-gnu-stable` only on nightly)
 - rust-lang#87565 (Use backticks when referring to `core::future::Ready` in panic message)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 87c9f32 into rust-lang:master Jul 29, 2021
@rustbot rustbot added this to the 1.56.0 milestone Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JohnTitor JohnTitor JohnTitor approved these changes

Assignees

@JohnTitor JohnTitor

Labels
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.56.0
Development

Successfully merging this pull request may close these issues.
10 participants
@D1mon @rust-highfive @the8472 @bors @joshtriplett @jyn514 @JohnTitor @JohnCSimon @yaahc @rustbot