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

Improve the rust style guide doc #114262

Merged
merged 2 commits into from
Aug 1, 2023
Merged

Improve the rust style guide doc #114262

merged 2 commits into from
Aug 1, 2023

Conversation

ShapelessCat
Copy link
Contributor

  • Make the levels of headings consistent in this whole document.
    Before this change, the highest level of headings in some file is level 1, but in most of the files the that is level 2. Not consistent.

  • Fix some headings

  • Follow the markdown linter advices

    • Remove redundant empty lines
    • Surround each heading with empty lines
    • Use the same symbol for different levels of unordered list entries

@ShapelessCat
Improve the rust style guide doc
b4b540c 
- Make the levels of headings consistent in this whole document
- Fix some headings
- Remove redundant empty lines
- Follow the markdown linter advices to use the same symbol for different level of unordered list entries
@rustbot
Copy link
Collaborator

rustbot commented Jul 30, 2023

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. 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 S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-style Relevant to the style team, which will review and decide on the PR/issue. labels Jul 30, 2023
@rustbot
Copy link
Collaborator

rustbot commented Jul 30, 2023

Some changes occurred in src/doc/style-guide

cc @rust-lang/style

@joshtriplett
Copy link
Member

joshtriplett commented Jul 30, 2023 •
edited
Loading

Big fan of unifying the heading levels; thank you! Bikeshed: Would rather not see - bullets changed to *. (If anything I'd prefer to consistently go the other way, but I'm not sure if it's worth the churn.)

@ShapelessCat
Copy link
Contributor Author

Big fan of unifying the heading levels; thank you! Bikeshed: Would rather not see - bullets changed to *. (If anything I'd prefer to consistently go the other way, but I'm not sure if it's worth the churn.)

Done. Use -.

@joshtriplett
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jul 31, 2023

📌 Commit 9d38e98 has been approved by joshtriplett

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 Jul 31, 2023
@matthiaskrgr matthiaskrgr mentioned this pull request Aug 1, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 1, 2023
@bors
Auto merge of rust-lang#114318 - matthiaskrgr:rollup-c7gcw18, r=matth…
c435af0 
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#111081 (impl SliceIndex<str> for (Bound<usize>, Bound<usize>))
 - rust-lang#113394 (style-guide: Document style editions, start 2024 style edition)
 - rust-lang#113588 (bootstrap: use git merge-base for LLVM CI download logic)
 - rust-lang#113743 (Directly link more target docs)
 - rust-lang#114262 (Improve the rust style guide doc)
 - rust-lang#114309 (Update books)
 - rust-lang#114313 ([rustc_data_structures] Simplify SortedMap::insert.)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 2fac397 into rust-lang:master Aug 1, 2023
11 checks passed
@rustbot rustbot added this to the 1.73.0 milestone Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@yaahc yaahc

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-style Relevant to the style team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.73.0
Development

Successfully merging this pull request may close these issues.
5 participants
@ShapelessCat @rustbot @joshtriplett @bors @yaahc