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

Add a flag in comment_formats to escape invalid markdown links #374

Closed
lquerel opened this issue Sep 18, 2024 · 0 comments · Fixed by #379
Closed

Add a flag in comment_formats to escape invalid markdown links #374

lquerel opened this issue Sep 18, 2024 · 0 comments · Fixed by #379
Assignees
Labels
enhancement New feature or request

Comments

@lquerel
Copy link
Contributor

lquerel commented Sep 18, 2024

Some brief and note fields contain non-escaped square brackets that don't represent valid Markdown links, such as ranges like [0,n]. cargo doc rejects any links that don't reference internal definitions, even though most markdown linters tolerate them. The proposal is to add a new parameter, escape_square_brackets, in the markdown configuration to automatically escape such invalid links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant