Skip to content

docs: clarify the editions behavior and it's consequences on formatting #6486

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

Merged
merged 9 commits into from
Feb 27, 2025
+47 −6
Merged

docs: clarify the editions behavior and it's consequences on formatting #6486

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f7afddf
docs: clarify the editions behavior and it's consequences on formatting
karolzwolak Feb 25, 2025
15781b2
docs: correct that style_edition dictates formatting settings, not ed…
karolzwolak Feb 25, 2025
a680d9a
docs: fix Rust Style Guide links
karolzwolak Feb 25, 2025
b4ed076
docs: revert changing link to rust style guide
karolzwolak Feb 25, 2025
4b49611
docs: link to edition in style_edition section
karolzwolak Feb 25, 2025
ecf3b62
docs: more accurate docs about `editon` and `style_edition` options
karolzwolak Feb 27, 2025
14f12fb
docs: ensure consistency between readme and configuration docs on edi…
karolzwolak Feb 27, 2025
4f89165
docs: improve tip on edition inconsistency between cargo and rustfmt
karolzwolak Feb 27, 2025
9fb7d89
docs: remove confusing sentence in editions tips
karolzwolak Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,10 @@ style_edition = "2024"

## Tips

* When using `rustfmt` directly in a Cargo project, Cargo will determine [`edition`](#rusts-editions) from `Cargo.toml`, but rustfmt will not, as it has its own configuration file, `rustfmt.toml`.
To ensure consistent parsing between `cargo fmt` and `rustfmt`, you should configure the [`edition`](#rusts-editions) in your `rustfmt.toml` file.
To ensure consistent formatting between `cargo fmt` and `rustfmt`, you should configure the [`style_edition`](#style-editions) in your `rustfmt.toml` file.

* For things you do not want rustfmt to mangle, use `#[rustfmt::skip]`
* To prevent rustfmt from formatting a macro or an attribute,
use `#[rustfmt::skip::macros(target_macro_name)]` or
Expand Down Expand Up @@ -241,8 +245,6 @@ style_edition = "2024"
| checkstyle | emits in a checkstyle format | Yes |
| json | emits diffs in a json format | Yes |

* When using `rustfmt` directly in a Cargo project, set the `style_edition` or `edition` in `rustfmt.toml` to the same value as in `Cargo.toml` to ensure consistent formatting. For more details, see the [Style Editions](#style-editions) and [Rust's Editions](#rusts-editions) sections.

## License

Rustfmt is distributed under the terms of both the MIT license and the
Expand Down
Loading