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

process.rs: remove "Basic usage" text where not useful #129916

Merged
merged 1 commit into from
Sep 3, 2024

Conversation

tshepang
Copy link
Member

@tshepang tshepang commented Sep 2, 2024

Is not useful because just a single example is given.

Is not useful because just a single example is given.
@rustbot
Copy link
Collaborator

rustbot commented Sep 2, 2024

r? @ChrisDenton

rustbot has assigned @ChrisDenton.
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 Sep 2, 2024
@tshepang
Copy link
Member Author

tshepang commented Sep 2, 2024

If an example is marked as "Basic usage", I would expect for there to also be "Advanced usage" example (or similar), but in these cases, only a single example is given.

Also, it would be too verbose to try to explain these examples, and they are already explained in the API and in the docs. I see the examples as complementary, and should offer clarity on their own. If not, we could add additional text to explain.

@tshepang
Copy link
Member Author

tshepang commented Sep 2, 2024

oh, I see they removed their comment... they were concerned that the pr removes clarity, and that I should rather state what the examples do

@ChrisDenton
Copy link
Member

"basic usage" does seem redundant given the context

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 2, 2024

📌 Commit 0a89f72 has been approved by ChrisDenton

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 Sep 2, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 3, 2024
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#129152 (custom/external clippy support for bootstrapping)
 - rust-lang#129311 (don't copy `.rustc-dev-contents` from CI rustc)
 - rust-lang#129800 (Move the Windows remove_dir_all impl into a module and make it more race resistant)
 - rust-lang#129860 (update `object` dependency to remove duplicate `wasmparser`)
 - rust-lang#129885 (chore: remove repetitive words)
 - rust-lang#129913 (Add missing read_buf stub for x86_64-unknown-l4re-uclibc)
 - rust-lang#129916 (process.rs: remove "Basic usage" text where not useful)
 - rust-lang#129917 (Fix parsing of beta version in dry-run mode)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 6e38c9b into rust-lang:master Sep 3, 2024
6 checks passed
@rustbot rustbot added this to the 1.83.0 milestone Sep 3, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Sep 3, 2024
Rollup merge of rust-lang#129916 - tshepang:basic-usage, r=ChrisDenton

process.rs: remove "Basic usage" text where not useful

Is not useful because just a single example is given.
@tshepang tshepang deleted the basic-usage branch September 3, 2024 09:44
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