diff --git a/README.md b/README.md index 2738363160ab..cc5fb979c527 100644 --- a/README.md +++ b/README.md @@ -179,6 +179,18 @@ needs to be specified in `rustfmt.toml`, e.g., with `edition = "2018"`. ## Tips * For things you do not want rustfmt to mangle, use `#[rustfmt::skip]` +* To prevent rustfmt from formatting a macro, + use `#[rustfmt::skip::macros(target_macro_name)]` + + Example: + + ```rust + #[rustfmt::skip::macros(html)] + fn main() { + let macro_result1 = html! {
+ Hello
+ }.to_string(); + ``` * When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in target file directory or its parents to override the default settings of rustfmt. You can generate a file containing the default configuration with @@ -205,19 +217,6 @@ needs to be specified in `rustfmt.toml`, e.g., with `edition = "2018"`. | coverage | displays how much of the input file was processed | Yes | | checkstyle | emits in a checkstyle format | Yes | -* To prevent rustfmt from formatting a macro, - use `#[rustfmt::skip::macros(target_macro_name)]` - - Example: - -```rust -#[rustfmt::skip::macros(html)] -fn main() { - let macro_result1 = html! {
-Hello
- }.to_string(); -``` - ## License Rustfmt is distributed under the terms of both the MIT license and the