Skip to content

Review of nightly style process #202

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

Open
traviscross opened this issue Dec 31, 2024 · 2 comments
Open

Review of nightly style process #202

traviscross opened this issue Dec 31, 2024 · 2 comments

Comments

@traviscross
Copy link

traviscross commented Dec 31, 2024

Filing the question from...

...separately so it's not lost.

@ehuss asks:

I'm a little unclear on what the style team intends for how future changes are documented. For example, the current style-guide documented behavior that rustfmt does not support. I'm not sure who the audience for this document is, or how this is intended to stay in sync with rustfmt. For example, if I read this and assume this is how it is supposed to work, and then rustfmt breaks that, it seems like that is confusing. Similarly, if I'm staying on an older edition, this documentation would be incorrect for my crate.

Perhaps changes like this could be "teed-up" in a PR, but not merged until the edition is stabilized (similar to how the reference works)? And include notes for parts that are edition-specific (so if I am using an older edition, I can see that something is different). In general, I'm a little confused on how this is intended to work.

Probably I'd frame this as a prompt for the style team to discuss whether, in light of experience, including with the edition, it is still happy with the nightly style process, or whether any changes might be worth considering.

@rustbot labels +I-style-nominated

cc @rust-lang/style

@rustbot
Copy link
Collaborator

rustbot commented Dec 31, 2024

Error: Malformed triagebot.toml in default branch.
TOML parse error at line 5, column 7
|
5 | "*" = "style"
| ^^^^^^^
invalid type: string "style", expected a sequence

Please file an issue on GitHub at triagebot if there's a problem with this bot, or reach out on #t-infra on Zulip.

@calebcartwright
Copy link
Member

calebcartwright commented Apr 9, 2025

I think Eric's original question is actually covered by:

https://doc.rust-lang.org/style-guide/editions.html#rust-2024-style-edition

This style guide describes the Rust 2024 style edition. The Rust 2024 style edition is currently nightly-only and may change before the release of Rust 2024.

For a full history of changes in the Rust 2024 style edition, see the git history of the style guide. Notable changes in the Rust 2024 style edition include:

The Style Guide text in-tree is reflective of the next, nightly-only Style Edition which is mutable and may or may not reflect implemented formatting behavior (i.e. the style guide text would now represent Style Edition 2027 or whatever vNext would be, not the stabilized style edition prescriptions for 2024 and below).

I'm open to trying to make that distinction more prominent if there are any suggestions on how to do so

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants