Rename fn_args_layout config option to fn_params_layout (#4163)

ayazhafiz · web-flow · commit 93345f54bf9d · 2020-05-10T20:52:59.000+09:00
diff --git a/Configurations.md b/Configurations.md
@@ -637,9 +637,9 @@ trailing whitespaces.
 - **Possible values**: `true`, `false`
 - **Stable**: No (tracking issue: [#3392](https://github.com/rust-lang/rustfmt/issues/3392))
 
-## `fn_args_layout`
+## `fn_params_layout`
 
-Control the layout of arguments in a function
+Control the layout of parameters in a function signature
 
 - **Default value**: `"Tall"`
 - **Possible values**: `"Compressed"`, `"Tall"`, `"Vertical"`
diff --git a/rustfmt-core/rustfmt-lib/src/config.rs b/rustfmt-core/rustfmt-lib/src/config.rs
@@ -108,8 +108,8 @@ create_config! {
         the same line with the pattern of arms";
     force_multiline_blocks: bool, false, false,
         "Force multiline closure bodies and match arms to be wrapped in a block";
-    fn_args_layout: Density, Density::Tall, true,
-        "Control the layout of arguments in a function";
+    fn_params_layout: Density, Density::Tall, true,
+        "Control the layout of parameters in a function signature";
     brace_style: BraceStyle, BraceStyle::SameLineWhere, false, "Brace style for items";
     control_brace_style: ControlBraceStyle, ControlBraceStyle::AlwaysSameLine, false,
         "Brace style for control flow constructs";
@@ -552,7 +552,7 @@ struct_field_align_threshold = 0
 enum_discrim_align_threshold = 0
 match_arm_blocks = true
 force_multiline_blocks = false
-fn_args_layout = "Tall"
+fn_params_layout = "Tall"
 brace_style = "SameLineWhere"
 control_brace_style = "AlwaysSameLine"
 trailing_semicolon = true
diff --git a/rustfmt-core/rustfmt-lib/src/items.rs b/rustfmt-core/rustfmt-lib/src/items.rs
@@ -2613,7 +2613,7 @@ fn rewrite_params(
         &param_items,
         context
             .config
-            .fn_args_layout()
+            .fn_params_layout()
             .to_list_tactic(param_items.len()),
         Separator::Comma,
         one_line_budget,
diff --git a/rustfmt-core/rustfmt-lib/tests/config/small_tabs.toml b/rustfmt-core/rustfmt-lib/tests/config/small_tabs.toml
@@ -3,7 +3,7 @@ comment_width = 80
 tab_spaces = 2
 newline_style = "Unix"
 brace_style = "SameLineWhere"
-fn_args_layout = "Tall"
+fn_params_layout = "Tall"
 trailing_comma = "Vertical"
 indent_style = "Block"
 reorder_imports = false
diff --git a/rustfmt-core/rustfmt-lib/tests/source/configs/fn_params_layout/compressed.rs b/rustfmt-core/rustfmt-lib/tests/source/configs/fn_params_layout/compressed.rs
@@ -1,5 +1,5 @@
-// rustfmt-fn_args_layout: Compressed
-// Function arguments density
+// rustfmt-fn_params_layout: Compressed
+// Function parameter density
 
 trait Lorem {
     fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
diff --git a/rustfmt-core/rustfmt-lib/tests/source/configs/fn_params_layout/tall.rs b/rustfmt-core/rustfmt-lib/tests/source/configs/fn_params_layout/tall.rs
@@ -1,5 +1,5 @@
-// rustfmt-fn_args_layout: Tall
-// Function arguments density
+// rustfmt-fn_params_layout: Tall
+// Function parameter density
 
 trait Lorem {
     fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
diff --git a/rustfmt-core/rustfmt-lib/tests/source/configs/fn_params_layout/vertical.rs b/rustfmt-core/rustfmt-lib/tests/source/configs/fn_params_layout/vertical.rs
@@ -1,5 +1,5 @@
-// rustfmt-fn_args_layout: Vertical
-// Function arguments density
+// rustfmt-fn_params_layout: Vertical
+// Function parameter density
 
 trait Lorem {
     fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
diff --git a/rustfmt-core/rustfmt-lib/tests/source/fn-custom-7.rs b/rustfmt-core/rustfmt-lib/tests/source/fn-custom-7.rs
@@ -1,5 +1,5 @@
 // rustfmt-normalize_comments: true
-// rustfmt-fn_args_layout: Vertical
+// rustfmt-fn_params_layout: Vertical
 // rustfmt-brace_style: AlwaysNextLine
 
 // Case with only one variable.
diff --git a/rustfmt-core/rustfmt-lib/tests/source/fn-custom.rs b/rustfmt-core/rustfmt-lib/tests/source/fn-custom.rs
@@ -1,4 +1,4 @@
-// rustfmt-fn_args_layout: Compressed
+// rustfmt-fn_params_layout: Compressed
 // Test some of the ways function signatures can be customised.
 
 // Test compressed layout of args.
diff --git a/rustfmt-core/rustfmt-lib/tests/source/fn_params_layout-vertical.rs b/rustfmt-core/rustfmt-lib/tests/source/fn_params_layout-vertical.rs
@@ -1,4 +1,4 @@
-// rustfmt-fn_args_layout: Vertical
+// rustfmt-fn_params_layout: Vertical
 
 // Empty list should stay on one line.
 fn do_bar(
diff --git a/rustfmt-core/rustfmt-lib/tests/target/configs/fn_params_layout/compressed.rs b/rustfmt-core/rustfmt-lib/tests/target/configs/fn_params_layout/compressed.rs
@@ -1,5 +1,5 @@
-// rustfmt-fn_args_layout: Compressed
-// Function arguments density
+// rustfmt-fn_params_layout: Compressed
+// Function parameter density
 
 trait Lorem {
     fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
diff --git a/rustfmt-core/rustfmt-lib/tests/target/configs/fn_params_layout/tall.rs b/rustfmt-core/rustfmt-lib/tests/target/configs/fn_params_layout/tall.rs
@@ -1,5 +1,5 @@
-// rustfmt-fn_args_layout: Tall
-// Function arguments density
+// rustfmt-fn_params_layout: Tall
+// Function parameter density
 
 trait Lorem {
     fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
diff --git a/rustfmt-core/rustfmt-lib/tests/target/configs/fn_params_layout/vertical.rs b/rustfmt-core/rustfmt-lib/tests/target/configs/fn_params_layout/vertical.rs
@@ -1,5 +1,5 @@
-// rustfmt-fn_args_layout: Vertical
-// Function arguments density
+// rustfmt-fn_params_layout: Vertical
+// Function parameter density
 
 trait Lorem {
     fn lorem(
diff --git a/rustfmt-core/rustfmt-lib/tests/target/fn-custom-7.rs b/rustfmt-core/rustfmt-lib/tests/target/fn-custom-7.rs
@@ -1,5 +1,5 @@
 // rustfmt-normalize_comments: true
-// rustfmt-fn_args_layout: Vertical
+// rustfmt-fn_params_layout: Vertical
 // rustfmt-brace_style: AlwaysNextLine
 
 // Case with only one variable.
diff --git a/rustfmt-core/rustfmt-lib/tests/target/fn-custom.rs b/rustfmt-core/rustfmt-lib/tests/target/fn-custom.rs
@@ -1,4 +1,4 @@
-// rustfmt-fn_args_layout: Compressed
+// rustfmt-fn_params_layout: Compressed
 // Test some of the ways function signatures can be customised.
 
 // Test compressed layout of args.
diff --git a/rustfmt-core/rustfmt-lib/tests/target/fn_params_layout-vertical.rs b/rustfmt-core/rustfmt-lib/tests/target/fn_params_layout-vertical.rs
@@ -1,4 +1,4 @@
-// rustfmt-fn_args_layout: Vertical
+// rustfmt-fn_params_layout: Vertical
 
 // Empty list should stay on one line.
 fn do_bar() -> u8 {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// rustfmt-fn_args_layout: Compressed`
	`1`	`+// rustfmt-fn_params_layout: Compressed`
`2`	`2`	`// Test some of the ways function signatures can be customised.`
`3`	`3`
`4`	`4`	`// Test compressed layout of args.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// rustfmt-fn_args_layout: Vertical`
	`1`	`+// rustfmt-fn_params_layout: Vertical`
`2`	`2`
`3`	`3`	`// Empty list should stay on one line.`
`4`	`4`	`fn do_bar(`