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

Move style guide to rust-lang/rust #102239

Merged
merged 4 commits into from
Oct 12, 2022
Merged

Move style guide to rust-lang/rust #102239

merged 4 commits into from
Oct 12, 2022

Conversation

joshtriplett
Copy link
Member

Per RFC 3309.

@rust-highfive
Copy link
Collaborator

r? @ehuss

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 24, 2022
@rustbot rustbot added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Sep 24, 2022
@joshtriplett joshtriplett added the T-style Relevant to the style team, which will review and decide on the PR/issue. label Sep 24, 2022
@joshtriplett
Copy link
Member Author

r? @calebcartwright

@joshtriplett joshtriplett mentioned this pull request Sep 24, 2022
Merged
jyn514
jyn514 approved these changes Sep 25, 2022
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

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

I'm going to trust that the guide itself is the same as it was in the other repo.

This looks good to me :)

src/bootstrap/doc.rs Show resolved Hide resolved
@joshtriplett
Copy link
Member Author

@bors r+

@bors
Copy link
Contributor

bors commented Sep 25, 2022

📌 Commit 9a72a66 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 Sep 25, 2022
@calebcartwright
Copy link
Member

I could certainly see moving the style guide under the rust-lang org, but I'm not sure whether moving into the main repo here is the right move. To be clear, I'm not necessarily opposed, just unsure of the best path forward.

I recognize that we've yet to finalize our approach to evolving the style guide text, but either way I suspect that we'll end up relying on git tags to capture markers/milestones for the prior version. Is that something we could feasibly do if the guide lives here? I.e. if we end up going the edition-bound route, which tag(s) would we be able to have in this repo that capture the 2015-2021 versions of the style guide?

@calebcartwright
Copy link
Member

And going to remove the approval for the moment to allow for a bit more discussion

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Sep 25, 2022
@joshtriplett
Copy link
Member Author

👍 for pausing this PR; the only reason I went ahead was because doing so was in the RFC.

@calebcartwright wrote:

I recognize that we've yet to finalize our approach to evolving the style guide text, but either way I suspect that we'll end up relying on git tags to capture markers/milestones for the prior version. Is that something we could feasibly do if the guide lives here? I.e. if we end up going the edition-bound route, which tag(s) would we be able to have in this repo that capture the 2015-2021 versions of the style guide?

I can see a couple different options there:

  • Link from the style guide to a rendered version of the past style guide, by version tag (e.g. https://doc.rust-lang.org/1.xx.0/style-guide). This works as long as we ensure a version of the style guide for each edition shows up in a release.
  • Copy style-guide to style-guide-2015 or similar. This won't use up any additional space in the repository, and will provide a rendered version we can link to.

@calebcartwright
Copy link
Member

the only reason I went ahead was because doing so was in the RFC.

You are 100% correct, I just somehow completely overlooked this rather important detail during the RFC, my apologies. I remain unopposed to this change but have a final question or two I should've asked on the original RFC which I'll pose over in rust-lang/rfcs#3320

calebcartwright
calebcartwright approved these changes Oct 12, 2022
View reviewed changes
Copy link
Member

@calebcartwright calebcartwright left a comment

Choose a reason for hiding this comment

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

@bors r+

@calebcartwright
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented Oct 12, 2022

📌 Commit 9a72a66 has been approved by calebcartwright

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 12, 2022
@Dylan-DPC Dylan-DPC mentioned this pull request Oct 12, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 12, 2022
@bors
Auto merge of rust-lang#102948 - Dylan-DPC:rollup-j8h74rb, r=Dylan-DPC
e6ce562 
Rollup of 8 pull requests

Successful merges:

 - rust-lang#102110 (Migrate rustc_passes diagnostics)
 - rust-lang#102187 (Use correct location for type tests in promoted constants)
 - rust-lang#102239 (Move style guide to rust-lang/rust)
 - rust-lang#102578 (Panic for invalid arguments of `{integer primitive}::ilog{,2,10}` in all modes)
 - rust-lang#102811 (Use memset to initialize readbuf)
 - rust-lang#102890 (Check representability in adt_sized_constraint)
 - rust-lang#102913 (unify `IsPattern` and `IsImport` enum in `show_candidates`)
 - rust-lang#102924 (rustdoc: remove unused classes from sidebar links)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit f8723f9 into rust-lang:master Oct 12, 2022
@rustbot rustbot added this to the 1.66.0 milestone Oct 12, 2022
@joshtriplett joshtriplett deleted the style-guide branch October 16, 2022 19:44
@calebcartwright calebcartwright mentioned this pull request Jan 18, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@calebcartwright calebcartwright calebcartwright approved these changes

@jyn514 jyn514 jyn514 approved these changes

Assignees

@calebcartwright calebcartwright

Labels
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) T-style Relevant to the style team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.66.0
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@joshtriplett @rust-highfive @bors @calebcartwright @jyn514 @ehuss @rustbot