We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Items linked in rust doc comments are inconsistently formatted.
Discussed in #5061 (comment).
The most common structure is
[s2n_api]
But we also use
[`s2n_api`]
which renders the links in a monospaced font.
We should standardize on the monospaced approach.
This seems to be the standard, as seen here in tokio docs, and as seen here in the rustdoc book.
The text was updated successfully, but these errors were encountered:
@jmayclin can I work on this?
Sorry, something went wrong.
sure!
No branches or pull requests
Problem:
Items linked in rust doc comments are inconsistently formatted.
Discussed in #5061 (comment).
The most common structure is
But we also use
which renders the links in a monospaced font.
Solution:
We should standardize on the monospaced approach.
This seems to be the standard, as seen here in tokio docs, and as seen here in the rustdoc book.
Requirements / Acceptance Criteria:
The text was updated successfully, but these errors were encountered: