tests/target: Add failing test for docstring in enum #6279
Closed
Conversation
This file contains 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
Follow instructions on Contributing.md [1] to create a test case. [1] https://github.com/rust-lang/rustfmt/blob/40f507526993651ad3b92eda89d5b1cebd0ed374/Contributing.md#L33 `tests/target/rust-doc-in-enum/without-doc.rs` is being left unformatted (expected behavior), while ``tests/target/rust-doc-in-enum/with-doc.rs` is formatted to `C { a: usize }` (unexpected behavior). The only different between the two samples is the `/// C` rustdoc added in `with-doc.rs`. As far as I can tell, this reproducing example is minimal: for example, after removing `d: usize` we do not reproduce the reported behavior. I found this issue while adding rustdocs to an existing project. I would expect that adding a line of documentation should not cause the formatting of the code to change.
|
Closing since this just demonstrates the issue already described in #6280 |
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.
For the time being, this PR only adds a failing test describing an unexpected behavior.
Issue
tests/target/rust-doc-in-enum/without-doc.rsis being left unformatted (expected behavior), while ``tests/target/rust-doc-in-enum/with-doc.rsis formatted toC { a: usize }` (unexpected behavior).The only different between the two samples is the
/// Crustdoc added inwith-doc.rs.As far as I can tell, this reproducing example is minimal: for example, after removing
d: usizewe do not reproduce the reported behavior.I found this issue while adding rustdocs to an existing project. I would expect that adding a line of documentation should not cause the formatting of the code to change.