add rustfmt raw identifer sorting doc #321

calebcartwright · 2024-09-04T04:58:25Z

joshtriplett · 2024-09-04T20:43:43Z

👍 This looks good.

I don't think this is captured in the style guide, and it should be.

ehuss · 2024-09-04T22:05:12Z

BTW, new pages need to be added to src/SUMMARY.md.

I was wondering about the rustfmt changes and whether or not they all need to be on separate pages. I'm unclear about how many changes (from the list) will end up in the edition. If individual changes don't have significant text associated with them, I was wondering if putting them on the same page might make sense (especially if the Migration section is identical for each one).

However, if a single page ends up being really long, then that probably wouldn't be good.

Not something we need to decide right now, but would be good to think about.

traviscross · 2024-09-04T22:12:18Z

Yes, I had similar thoughts in both directions, as you described, and ended up suggesting just doing one per page to @calebcartwright. That makes it a bit easier to follow the flow and template of the other pages, allows us to merge these individually without conflicts, etc. We can always merge them into one page later if we find it better editorially.

calebcartwright · 2024-09-05T15:02:54Z

Agreed. I'll continue filing these as individual pages but I think most of them would be best merged into one (otherwise I could see a disproportionately high ratio of text in the edition guide doc being "run cargo fmt" repeated ad nauseam)

At this point I'm not entirely decided on which ones I think would be best combined on one page, but I'm leaning towards following the model we did for the Style Guide changelog where we had a single entry for "misc rustfmt fixes", which includes this raw ident sorting item.

If it doesn't add any harm/complexity for those of you driving the edition work, perhaps we could just leave these rustfmt PRs open here so that t-style/t-rustfmt can provide input on the text, and then I'll copy pasta things around (with relevant SUMMARY.md entries) and close some of the PRs once we figure out how to structure the full set?

ehuss · 2024-09-06T20:00:45Z

Seems fine to me!

ehuss · 2024-09-06T20:02:26Z

src/rust-2024/rustfmt-raw-identifiers.md

+```
+
+[Rust Style Guide]: https://doc.rust-lang.org/nightly/style-guide/index.html
+[sorting]: https://doc.rust-lang.org/stable/style-guide/index.html?highlight=sort#sorting


Just a suggestion to remove the highlighting.

Suggested change

[sorting]: https://doc.rust-lang.org/stable/style-guide/index.html?highlight=sort#sorting

[sorting]: https://doc.rust-lang.org/stable/style-guide/index.html#sorting

We needed to add an entry to the TOC, and we made various editorial tweaks.

We needed to add an entry to the ToC, and we made various editorial tweaks.

Update books ## rust-lang/edition-guide 7 commits in c7ebae25cb4801a31b6f05353f6d85bfa6feedd1..1f07c242f8162a711a5ac5a4ea8fa7ec884ee7a9 2024-10-21 14:29:49 UTC to 2024-10-19 19:08:20 UTC - 2024: Add reserved syntax (rust-lang/edition-guide#326) - Update stdout of `cargo new` (rust-lang/edition-guide#327) - Don't run doctests on rustfmt ident sorting page - add rustfmt raw identifer sorting doc (rust-lang/edition-guide#321) - Add some tips for what to be careful of with rustdoc-doctests (rust-lang/edition-guide#323) - Remove cargo-remove-implicit-features (rust-lang/edition-guide#324) - Rename doctest standalone tag (rust-lang/edition-guide#325) ## rust-embedded/book 1 commits in f40a8b420ec4b4505d9489965e261f1d5c28ba23..ddbf1b4e2858fedb71b7c42eb15c4576517dc125 2024-10-13 19:53:37 UTC to 2024-10-13 19:53:37 UTC - Add link to Cortex-M comparison to install.md (rust-embedded/book#378) ## rust-lang/reference 29 commits in c64e52a3d306eac0129f3ad6c6d8806ab99ae2e9..23ce619966541bf2c80d45fdfeecf3393e360a13 2024-10-05 00:33:03 +0000 to 2024-10-22 21:34:51 +0000 - Mention `--print cfg` under set configuration options (rust-lang/reference#1636) - Fix `pat` fragment specifier to be the "current" edition (rust-lang/reference#1640) - Add restriction for cfg_attr with crate_type and crate_name (rust-lang/reference#1649) - Sort macro fragment specifiers (rust-lang/reference#1641) - Document mixed-site hygiene (rust-lang/reference#1656) - Clarify that "macro attributes" refers to proc macros (rust-lang/reference#1660) - mdbook-spec: Fix Spec::new creation (rust-lang/reference#1658) - Fix stdcall example broken by recent rustc change (rust-lang/reference#1659) - Add spec identifiers to const_eval.md (rust-lang/reference#1569) - Add identifier syntax to trait-bounds.md (rust-lang/reference#1631) - Add identifier syntax to macro-ambiguity.md (rust-lang/reference#1634) - Add spec identifier syntax to conditional-compilation.md (rust-lang/reference#1564) - Add spec identifiers to behaviour-considered-undefined.md (rust-lang/reference#1562) - Add test linking (rust-lang/reference#1646) - Allow `deny` inside `forbid` as a no-op (rust-lang/reference#1655) - Add identifier syntax to identifiers.md (rust-lang/reference#1583) - Add spec identifiers to crates-and-source-files.md (rust-lang/reference#1570) - Add identifier syntax to linkage.md (rust-lang/reference#1633) - Add identifier syntax to type-coercions.md (rust-lang/reference#1632) - Add identifiers to variables.md (rust-lang/reference#1626) - Add identifier syntax to lexer chapters (rust-lang/reference#1620) - Add spec identifier syntax to `unsafe-keyword.md` and `unsafety.md` (rust-lang/reference#1619) - Add identifier syntax to types and subchapters. (rust-lang/reference#1618) - Add identifier syntax to subtyping.md (rust-lang/reference#1613) - Add identifier syntax to statements.md (rust-lang/reference#1611) - Add identifier syntax to type-layout.md (rust-lang/reference#1614) - Clarify definition of "immutable bytes" (rust-lang/reference#1637) - Add preview artifacts in CI (rust-lang/reference#1647) - trait bounds grammar: make `?` and `for<>` mutually exclusive (rust-lang/reference#1650) ## rust-lang/rustc-dev-guide 5 commits in 07bc9ca9eb1cd6d9fbbf758c2753b748804a134f..59d94ea75a0b157e148af14c73c2dd60efb7b60a 2024-10-21 02:30:07 UTC to 2024-10-07 21:12:09 UTC - Add the WASM | WASI | Emscripten notification groups (rust-lang/rustc-dev-guide#2100) - Update bootstrapping.md (rust-lang/rustc-dev-guide#1900) - Rename `needs-profiler-support` to `needs-profiler-runtime` (rust-lang/rustc-dev-guide#2095) - Document compiletest directives `ignore-coverage-map` and `ignore-coverage-run` (rust-lang/rustc-dev-guide#2094) - Purge `run-pass-valgrind` mentions (rust-lang/rustc-dev-guide#2091)

add rustfmt raw identifer sorting doc

0cbff13

calebcartwright mentioned this pull request Sep 4, 2024

Tracking Issue for Rust 2024: rustfmt raw identifier sorting rust-lang/rust#124764

Open

3 tasks

ehuss reviewed Sep 6, 2024

View reviewed changes

traviscross added a commit to calebcartwright/edition-guide that referenced this pull request Oct 19, 2024

Prepare PR rust-lang#321 to be merged

579f939

We needed to add an entry to the TOC, and we made various editorial tweaks.

Prepare PR rust-lang#321 to be merged

8b64b52

We needed to add an entry to the ToC, and we made various editorial tweaks.

traviscross force-pushed the rustfmt-raw-identifiers branch from 579f939 to 8b64b52 Compare October 19, 2024 19:34

traviscross merged commit dae0f58 into rust-lang:master Oct 19, 2024
1 check failed

rustbot mentioned this pull request Oct 21, 2024

Update books rust-lang/rust#132007

Merged

calebcartwright deleted the rustfmt-raw-identifiers branch November 2, 2024 23:36

calebcartwright mentioned this pull request Nov 4, 2024

2024: rustfmt sorting #332

Merged

rustbot mentioned this pull request Nov 4, 2024

Update books rust-lang/rust#132601

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add rustfmt raw identifer sorting doc #321

add rustfmt raw identifer sorting doc #321

calebcartwright commented Sep 4, 2024 •

edited

Loading

joshtriplett commented Sep 4, 2024

ehuss commented Sep 4, 2024

traviscross commented Sep 4, 2024 •

edited

Loading

calebcartwright commented Sep 5, 2024

ehuss commented Sep 6, 2024

ehuss Sep 6, 2024

	[sorting]: https://doc.rust-lang.org/stable/style-guide/index.html?highlight=sort#sorting
	[sorting]: https://doc.rust-lang.org/stable/style-guide/index.html#sorting

add rustfmt raw identifer sorting doc #321

add rustfmt raw identifer sorting doc #321

Conversation

calebcartwright commented Sep 4, 2024 • edited Loading

joshtriplett commented Sep 4, 2024

ehuss commented Sep 4, 2024

traviscross commented Sep 4, 2024 • edited Loading

calebcartwright commented Sep 5, 2024

ehuss commented Sep 6, 2024

ehuss Sep 6, 2024

Choose a reason for hiding this comment

calebcartwright commented Sep 4, 2024 •

edited

Loading

traviscross commented Sep 4, 2024 •

edited

Loading