-
Notifications
You must be signed in to change notification settings - Fork 925
Add options blank_lines_{lower|upper}_bound
to Configurations.md
#2313
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
Merged
Merged
Changes from all commits
Commits
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
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.
This code block will break the unmerged test in #2292 because that test expects all Rust code blocks to be preceded by "## `CONFIG_NAME`" and "#### 'CONFIG_VALUE`", in that order. That's the convention that has been followed to this point, at least.
So we need to either update this documentation to match that convention or I need to update the test in #2292 to have a way to opt Rust code blocks out of verification. Is it feasible to modify this documentation or is the example code before the formatted code preferable for clarity?
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.
Mh, I think that these two configurations are different from the other ones in that changing the value is not "bijective": formatting with a decreased blank line bound will lose information, so increasing the blank line bound and formatting it again won't result in the code we started with. So I wouldn't use the convention here, as it would be less clear to the reader.
I am not sure if there should be a special case in your tests for this; it's probably to complicated right now. So you are probably right: opting out of the test for the first code block and still testing the others is probably fine.
But I'm fine with whatever you (all) decide on :)