Open
Conversation
onur-ozkan
reviewed
Apr 1, 2026
| /// # Errors | ||
| /// | ||
| /// See [`read_` function error documentation](crate#read-errors) | ||
| /// See [`read_` function error documentation](crate#read-errors). |
Member
There was a problem hiding this comment.
I don't think this change is necessary. It doesn't add much value and it overlaps with the existing history, which may make it harder for someone to find the commit where the change was originally introduced.
Same applies to majority of this PR. I only see couple of lines where the change actually makes sense.
onur-ozkan
reviewed
Apr 1, 2026
| unnecessary_semicolon = "warn" | ||
| uninlined_format_args = "warn" | ||
| use_self = "warn" | ||
| doc_link_code = "warn" |
Member
There was a problem hiding this comment.
I am not sure this is a good lint. :/ I am personally more happy without the html tags being added to the repository.
I will leave this to other maintainters.
Contributor
Author
There was a problem hiding this comment.
Also not a fan of the <code> but it's impossible to achieve the same with ``. The previous creates multiple unconnected inline code blocks.
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
2 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.
Some doc improvements mostly based on the 2 lints bellow. Additionally the
parser::generate()function doc had references to things that do not apply anymore (message conversion between dialects, protobuf (?)). There are no functional changes.clippy::doc_link_code
<code>instead of multiple ``clippy::doc_paragraphs_missing_punctuation
system_id