-
Notifications
You must be signed in to change notification settings - Fork 925
Improve docs for single_line_if_else_max_width
& add tests
#5509
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.
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
Open
truls-p
wants to merge
8
commits into
rust-lang:master
Choose a base branch
from
truls-p:improve-docs-if-else-max
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
41af7e7
Add details to documentation + examples
truls-p f60a569
Add tests for `single_line_if_else_max_width`
truls-p 37d9b88
Refine documentation + add additional tests for `single_line_if_else_…
truls-p d6f3a90
Update Configurations.md
truls-p a372baa
Reformat description in Configurations.md
truls-p c021610
Add some more whitespace in examples, but remove unnecessary spaces
truls-p 63ccc1c
Add missing newlines in tests/source files
truls-p a536146
Some small tweaks to Configuration.md
truls-p File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
// rustfmt-version: One | ||
// rustfmt-single_line_if_else_max_width: 70 | ||
fn foo() -> usize { | ||
let some_long_name = true; | ||
let some_other_long_name = false; | ||
let bar = if some_long_name && some_other_long_name { baz() } else { buzz() }; | ||
if some_long_name && some_other_long_name { 1 } else { 2 } | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
// rustfmt-version: Two | ||
// rustfmt-single_line_if_else_max_width: 70 | ||
fn foo() -> usize { | ||
let some_long_name = true; | ||
let some_other_long_name = false; | ||
let bar = if some_long_name && some_other_long_name { baz() } else { buzz() }; | ||
if some_long_name && some_other_long_name { | ||
1 | ||
} else { | ||
2 | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
fn foo() -> usize { | ||
let some_long_name = true; | ||
let some_other_long_name = false; | ||
let bar = if some_long_name && some_other_long_name { baz() } else { buzz() }; | ||
if some_long_name && some_other_long_name { 1 } else { 2 } | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
// rustfmt-version: One | ||
// rustfmt-single_line_if_else_max_width: 75 | ||
fn foo() -> usize { | ||
// nested | ||
let _ = if true { if false { 1 } else { 2 } } else { 3 }; | ||
let _ = if true { 3 } else { if false { 1 } else { 2 } }; | ||
let _ = if true { if false { 1 } else { 2 } } else { if false { 3 } else { 4 } }; | ||
|
||
1 | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
// rustfmt-version: Two | ||
// rustfmt-single_line_if_else_max_width: 75 | ||
fn foo() -> usize { | ||
// nested | ||
let _ = if true { | ||
if false { 1 } else { 2 } | ||
} else { | ||
3 | ||
}; | ||
let _ = if true { | ||
3 | ||
} else { | ||
if false { 1 } else { 2 } | ||
}; | ||
let _ = if true { | ||
if false { 1 } else { 2 } | ||
} else { | ||
if false { 3 } else { 4 } | ||
}; | ||
|
||
1 | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
// rustfmt-version: One | ||
fn foo() -> usize { | ||
// empty | ||
let _ = if true { 1 } else { }; | ||
let _ = if true { } else { 2 }; | ||
let _ = if true { } else { }; | ||
|
||
// attribute | ||
let _ = if true { #[must_use] 1 } else { 2 }; | ||
let _ = if true { 1 } else { #[must_use] 2 }; | ||
let _ = if true { #[must_use] 1 } else { #[must_use] 2 }; | ||
|
||
// comment | ||
let _ = if true { 1 /*1*/ } else { 2 }; | ||
let _ = if true { 1 } else { 2 /*2*/}; | ||
let _ = if true { 1 /*1*/} else { 2 /*2*/}; | ||
|
||
// a statement | ||
let _ = if true { let a = 1; a } else { 2 }; | ||
let _ = if true { 1 } else { let b = 2; b }; | ||
let _ = if true { let a = 1; a } else { let b = 2; b }; | ||
|
||
1 | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
// rustfmt-version: Two | ||
fn foo() -> usize { | ||
// empty | ||
let _ = if true { 1 } else { }; | ||
let _ = if true { } else { 2 }; | ||
let _ = if true { } else { }; | ||
|
||
// attribute | ||
let _ = if true { #[must_use] 1 } else { 2 }; | ||
let _ = if true { 1 } else { #[must_use] 2 }; | ||
let _ = if true { #[must_use] 1 } else { #[must_use] 2 }; | ||
|
||
// comment | ||
let _ = if true { 1 /*1*/ } else { 2 }; | ||
let _ = if true { 1 } else { 2 /*2*/}; | ||
let _ = if true { 1 /*1*/} else { 2 /*2*/}; | ||
|
||
// a statement | ||
let _ = if true { let a = 1; a } else { 2 }; | ||
let _ = if true { 1 } else { let b = 2; b }; | ||
let _ = if true { let a = 1; a } else { let b = 2; b }; | ||
|
||
1 | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
// rustfmt-version: One | ||
// rustfmt-single_line_if_else_max_width: 70 | ||
fn foo() -> usize { | ||
let some_long_name = true; | ||
let some_other_long_name = false; | ||
let bar = if some_long_name && some_other_long_name { baz() } else { buzz() }; | ||
if some_long_name && some_other_long_name { | ||
1 | ||
} else { | ||
2 | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
// rustfmt-version: Two | ||
// rustfmt-single_line_if_else_max_width: 70 | ||
fn foo() -> usize { | ||
let some_long_name = true; | ||
let some_other_long_name = false; | ||
let bar = if some_long_name && some_other_long_name { baz() } else { buzz() }; | ||
if some_long_name && some_other_long_name { 1 } else { 2 } | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
fn foo() -> usize { | ||
let some_long_name = true; | ||
let some_other_long_name = false; | ||
let bar = if some_long_name && some_other_long_name { | ||
baz() | ||
} else { | ||
buzz() | ||
}; | ||
if some_long_name && some_other_long_name { | ||
1 | ||
} else { | ||
2 | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
// rustfmt-version: One | ||
// rustfmt-single_line_if_else_max_width: 75 | ||
fn foo() -> usize { | ||
// nested | ||
let _ = if true { | ||
if false { | ||
1 | ||
} else { | ||
2 | ||
} | ||
} else { | ||
3 | ||
}; | ||
let _ = if true { | ||
3 | ||
} else { | ||
if false { | ||
1 | ||
} else { | ||
2 | ||
} | ||
}; | ||
let _ = if true { | ||
if false { | ||
1 | ||
} else { | ||
2 | ||
} | ||
} else { | ||
if false { | ||
3 | ||
} else { | ||
4 | ||
} | ||
}; | ||
|
||
1 | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
// rustfmt-version: Two | ||
// rustfmt-single_line_if_else_max_width: 75 | ||
fn foo() -> usize { | ||
// nested | ||
let _ = if true { | ||
if false { 1 } else { 2 } | ||
} else { | ||
3 | ||
}; | ||
let _ = if true { | ||
3 | ||
} else { | ||
if false { 1 } else { 2 } | ||
}; | ||
let _ = if true { | ||
if false { 1 } else { 2 } | ||
} else { | ||
if false { 3 } else { 4 } | ||
}; | ||
|
||
1 | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
// rustfmt-version: One | ||
fn foo() -> usize { | ||
// empty | ||
let _ = if true { | ||
1 | ||
} else { | ||
}; | ||
let _ = if true { | ||
} else { | ||
2 | ||
}; | ||
let _ = if true { | ||
} else { | ||
}; | ||
|
||
// attribute | ||
let _ = if true { | ||
#[must_use] | ||
1 | ||
} else { | ||
2 | ||
}; | ||
let _ = if true { | ||
1 | ||
} else { | ||
#[must_use] | ||
2 | ||
}; | ||
let _ = if true { | ||
#[must_use] | ||
1 | ||
} else { | ||
#[must_use] | ||
2 | ||
}; | ||
|
||
// comment | ||
let _ = if true { | ||
1 /*1*/ | ||
} else { | ||
2 | ||
}; | ||
let _ = if true { | ||
1 | ||
} else { | ||
2 /*2*/ | ||
}; | ||
let _ = if true { | ||
1 /*1*/ | ||
} else { | ||
2 /*2*/ | ||
}; | ||
|
||
// a statement | ||
let _ = if true { | ||
let a = 1; | ||
a | ||
} else { | ||
2 | ||
}; | ||
let _ = if true { | ||
1 | ||
} else { | ||
let b = 2; | ||
b | ||
}; | ||
let _ = if true { | ||
let a = 1; | ||
a | ||
} else { | ||
let b = 2; | ||
b | ||
}; | ||
|
||
1 | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have some reservations about any attempts to reference, or perhaps to some readers, codify formatting behavior here. The Style Guide is what articulates the rules for the formatting behavior, and the exact prescriptions for when
if-else
can/can't be single lined can be found here.This option exists as the mechanism to control the value used as the "small" threshold as described in the Guide, and I don't think we should have much more than that here.
Basically, the Config docs, and any particular option within them, isn't really the right place to try to explain the broader formatting rules for a given syntax construct