]> git.lizzy.rs Git - rust.git/commitdiff
put rustfmt::skip::macro mention together with the rustfmt::skip bullet point
authorStéphane Campinas <stephane.campinas@gmail.com>
Sun, 24 Mar 2019 17:25:10 +0000 (18:25 +0100)
committerGitHub <noreply@github.com>
Sun, 24 Mar 2019 17:25:10 +0000 (18:25 +0100)
README.md

index 2738363160abd1dd5fbd2981ab3675c5936cc110..cc5fb979c527faefad8fa23097826b37302ed989 100644 (file)
--- 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! { <div>
+    Hello</div>
+        }.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! { <div>
-Hello</div>
-    }.to_string();
-```
-
 ## License
 
 Rustfmt is distributed under the terms of both the MIT license and the