Skip to content
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

Don't wrap comments that are part of a table #5475

Merged
merged 4 commits into from
Jan 29, 2023

Conversation

Nemo157
Copy link
Member

@Nemo157 Nemo157 commented Jul 28, 2022

Closes #4210

This is a trivial cherry-pick of #4214 onto the new master branch.

src/comment.rs Outdated
@@ -939,6 +940,18 @@ fn has_url(s: &str) -> bool {
|| REFERENCE_LINK_URL.is_match(s)
}

/// Returns true if the given string may be part of a Markdown talble.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo

Suggested change
/// Returns true if the given string may be part of a Markdown talble.
/// Returns true if the given string may be part of a Markdown table.

Comment on lines 1 to 15
// rustfmt-wrap_comments: true

/// Table that is > 80 symbols:
///
/// | table | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
/// |-------|-----------------------------------------------------------------------------|
/// | val | x |
pub struct Item;

/// Table that is > 80 symbols:
///
/// | table | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
/// |-------|-----------------------------------------------------------------------------
/// | val | x
pub struct Item;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these are good tests ported over from the backport, however I'd like to build on these before merging.

I'd like to see a test case for wrap_comments=false (just for completeness). Additionally, I'd like to add some text before the table that gets wrapped when wrap_comments=true to further emphasize that the table isn't being wrapped even when the text is wrapped.

I also think we should add a row to the table (besides the header) that contains a long line to show that it also isn't wrapped.

@l4l
Copy link

l4l commented Dec 12, 2022

Any chance of merging this one?

@ytmimi
Copy link
Contributor

ytmimi commented Dec 12, 2022

@l4l we plan to merge this and all other PRs labeled as pr-ready-to-merge. We're holding off on merging PRs right now because we haven't done a subtree sync with rust-lang/rust in a while and want to get the sync in before merging PRs. Hopefully we'll be able to get this merged soon!

@calebcartwright calebcartwright added release-notes Needs an associated changelog entry and removed pr-ready-to-merge labels Jan 29, 2023
@calebcartwright calebcartwright merged commit 3f36c99 into rust-lang:master Jan 29, 2023
@calebcartwright calebcartwright removed the release-notes Needs an associated changelog entry label Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

wrap_comments = true breaks markdown tables
5 participants