Add escape_square_brackets
into comment_formats
markdown configuration
#379
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.
The
cargo doc
command does not properly handle non-escaped text containing square brackets when these brackets are not intended to represent links (e.g.,This is a [text] with square brackets that doesn't represent a link
). This PR addresses the issue by introducing a new flagescape_square_brackets
in the markdown configuration of thecomment_formats
section.This new flag ensures that text with square brackets, which are not intended as links, is properly escaped in the generated documentation.
Example:
Input Text:
Output Without the Flag:
Without the new flag, the following text is returned by the comment filter:
Output With the Flag Enabled:
When the new flag is enabled, the output becomes:
Closes #374