README: Note that rustfmt_skip on non-inline mod quiets line length warnings
#1406
Conversation
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
In the `README.md` document, note, after the introduction of the `rustfmt_skip` attribute, that using that attribute on a non-inline `mod` item will cause the file referenced by that item to be wholly ignored by rustfmt, in contrast to the normal behavior of still emitting warnings on lines in skipped sections of code that exceed the line length limit.
|
While this is correct, I don't think it is quite indicating the right mental model. Rustfmt will format the whole program skipping any nodes with a skip attribute. It will then run its warning pass on any files it knows about. Whether a module is skipped or not (c.f., any other node) doesn't really make a difference (for example if you skip an inline module, that module will be warned on, but if that module imports an out of line one, that file will not be checked). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In the
README.mddocument, note, after the introduction of therustfmt_skipattribute, that using that attribute on a non-inlinemoditem will cause the file referenced by that item to be whollyignored by rustfmt, in contrast to the normal behavior of still
emitting warnings on lines in skipped sections of code that exceed the
line length limit.
My motivation for this change is my former confusion as to this
behavior, as shown in issue #1399.
(I suppose, however, that merging of this patch should wait on the
resolution of solson's concerns.)