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

bindings: standardize link format #5095

Open
jmayclin opened this issue Feb 6, 2025 · 2 comments
Open

bindings: standardize link format #5095

jmayclin opened this issue Feb 6, 2025 · 2 comments

Comments

@jmayclin
Copy link
Contributor

jmayclin commented Feb 6, 2025

Problem:

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.

Solution:

We should standardize on the monospaced approach.

[`s2n_api`]

This seems to be the standard, as seen here in tokio docs, and as seen here in the rustdoc book.

Requirements / Acceptance Criteria:

  • all links to code items use the monospace format
  • grep_simple_mistakes is updated to account for the new format, and warn on the old one.
@manojks1999
Copy link

@jmayclin can I work on this?

@jmayclin
Copy link
Contributor Author

jmayclin commented Feb 8, 2025

sure!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants