Skip to content

Fix rustc-std-workspace-core documentation #80222

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
Dec 23, 2020
Merged

Fix rustc-std-workspace-core documentation #80222

merged 1 commit into from
Dec 23, 2020

Conversation

GreenRecycleBin
Copy link
Contributor

@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 @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

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 Dec 20, 2020
@jyn514
Copy link
Member

jyn514 commented Dec 21, 2020

Steve Klabnik mostly handles the user-facing docs, since this is internal documentation I think it should have technical feedback instead (bootstrapping is confusing!).

r? @alexcrichton

@jyn514 jyn514 added T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Dec 21, 2020
@jyn514
Copy link
Member

jyn514 commented Dec 21, 2020

Oh wait, this is just word-wrapping the docs. Personally I don't think this has a big impact on readability (and wouldn't recommend spending too much time on it since it's just for internal docs), but it's not worse.

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Dec 21, 2020

📌 Commit e614a72 has been approved by jyn514

@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 Dec 21, 2020
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Dec 21, 2020
@Dylan-DPC
Rollup merge of rust-lang#80222 - GreenRecycleBin:daniel/fix-rustc-st…
945ebe7 
…d-workspace-core-documentation, r=jyn514

Fix rustc-std-workspace-core documentation

r? `@steveklabnik`
@Dylan-DPC-zz Dylan-DPC-zz mentioned this pull request Dec 21, 2020
Closed
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Dec 22, 2020
@Dylan-DPC
Rollup merge of rust-lang#80222 - GreenRecycleBin:daniel/fix-rustc-st…
cac7101 
…d-workspace-core-documentation, r=jyn514

Fix rustc-std-workspace-core documentation

r? ``@steveklabnik``
@Dylan-DPC-zz Dylan-DPC-zz mentioned this pull request Dec 22, 2020
Closed
@GuillaumeGomez GuillaumeGomez mentioned this pull request Dec 22, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 23, 2020
@bors
Auto merge of rust-lang#80314 - GuillaumeGomez:rollup-9rc48vx, r=Guil…
89886e6 
…laumeGomez

Rollup of 17 pull requests

Successful merges:

 - rust-lang#80136 (Add test for issue rust-lang#74824)
 - rust-lang#80203 (Edit rustc_middle::lint::LintSource docs)
 - rust-lang#80204 (docs: Edit rustc_middle::ty::query::on_disk_cache)
 - rust-lang#80219 (Fix labels for 'Library Tracking Issue' template)
 - rust-lang#80222 (Fix rustc-std-workspace-core documentation)
 - rust-lang#80223 (docs: Fix outdated crate reference)
 - rust-lang#80225 (Add module-level docs to rustc_middle::ty)
 - rust-lang#80241 (Fix typo)
 - rust-lang#80248 (Remove `I-prioritize` from Zulip topic)
 - rust-lang#80266 (Remove redundant test)
 - rust-lang#80272 (rustc_span: Provide a reserved identifier check for a specific edition)
 - rust-lang#80285 (Update books)
 - rust-lang#80286 (docs: Edit rustc_middle::middle::privacy)
 - rust-lang#80297 (Add some intra-doc links to compiler docs)
 - rust-lang#80298 (Improve the code quality by using matches macro)
 - rust-lang#80299 (Turn helper method into a closure)
 - rust-lang#80302 (docs: Update rustc_middle::middle::region::ScopeTree)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 9446d43 into rust-lang:master Dec 23, 2020
@rustbot rustbot added this to the 1.50.0 milestone Dec 23, 2020
@GreenRecycleBin
Copy link
Contributor Author

GreenRecycleBin commented Dec 24, 2020 •
edited
Loading

Oh wait, this is just word-wrapping the docs. Personally I don't think this has a big impact on readability (and wouldn't recommend spending too much time on it since it's just for internal docs), but it's not worse.

@bors r+ rollup

If you look closely, I actually fixed a grammatical error and made the documentation more concise. The wrapping was necessary to preserve the style.

@GreenRecycleBin GreenRecycleBin deleted the daniel/fix-rustc-std-workspace-core-documentation branch December 24, 2020 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@alexcrichton alexcrichton

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Milestone
1.50.0
Development

Successfully merging this pull request may close these issues.
7 participants
@GreenRecycleBin @rust-highfive @jyn514 @bors @steveklabnik @alexcrichton @rustbot