Add new unescaped_pipe_in_table_cell rustdoc lint#159583
Open
GuillaumeGomez wants to merge 3 commits into
Open
Add new unescaped_pipe_in_table_cell rustdoc lint#159583GuillaumeGomez wants to merge 3 commits into
unescaped_pipe_in_table_cell rustdoc lint#159583GuillaumeGomez wants to merge 3 commits into
Conversation
rustbot
added
S-waiting-on-review
Collaborator
|
The job Click to see the possible cause of the failure (guessed by this bot) |
Urgau
reviewed
Jul 20, 2026
| @@ -0,0 +1,16 @@ | |||
| #![deny(rustdoc::unescaped_pipe_in_table_cell)] | |||
|
|
|||
| //! | col1 | | |||
Member
There was a problem hiding this comment.
Would be good to test edge-cases, what about adding another test case with two tables on the same doc comment.
Would also be interesting to have a test case with multiple wrong rows for the same table.
Comment on lines
+55
to
+56
| if c == '\\' { | ||
| iter.next(); |
Member
There was a problem hiding this comment.
Would be good to have a test case for this escaping as well.
| #[help("to escape `|` characters in tables, add a `\\` before them like `\\|`")] | ||
| struct UnescapedPipeInTableCell { | ||
| #[primary_span] | ||
| #[suggestion("any content after this column divider is discarded", code = "")] |
Member
There was a problem hiding this comment.
Shouldn't this be a label instead of an empty suggestion?
Suggested change
| #[suggestion("any content after this column divider is discarded", code = "")] | |
| #[label("any content after this column divider is discarded")] |
| if let Event::Start(Tag::Table(_)) = event | ||
| && let Some((Event::Start(Tag::TableHead), _)) = p.next() | ||
| { | ||
| let mut expected_count = 0; |
Member
There was a problem hiding this comment.
Suggested change
| let mut expected_count = 0; | |
| let mut expected_cells = 0; |
| // was left out. We now check the number of unescaped `|`. | ||
| let row = &dox[range.clone()]; | ||
| let mut iter = row.chars(); | ||
| let mut count = 0; |
Member
There was a problem hiding this comment.
Suggested change
| let mut count = 0; | |
| let mut divider_count = 0; |
Comment on lines
+46
to
+47
| if let Some(prev_range) = &prev_range | ||
| && prev_range.end + 1 != range.end |
Member
There was a problem hiding this comment.
I'm not sure what this is checking. Is it checking the line width? or is it checking the position of the last TableCell with the last TableRow?
Either way, a comment would greatly help.
Comment on lines
+28
to
+29
| if let Event::Start(Tag::Table(_)) = event | ||
| && let Some((Event::Start(Tag::TableHead), _)) = p.next() |
Member
There was a problem hiding this comment.
It's too bad that we have to do this checking manually, I don't suppose could pulldown_cmark to do this checking for us?
Urgau
added
S-waiting-on-author
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes #159186.
r? @Urgau