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

types: avoid markdown footnotes #268

Merged
merged 1 commit into from
Jul 6, 2024
Merged

Conversation

cpu
Copy link
Member

@cpu cpu commented Jul 6, 2024

Nightly rustdoc flags these as non-standard markdown, and they don't render as nicely as just using a link. See also rustls/rustls#2033

Fixes build errors on main.

Nightly rustdoc flags these as non-standard markdown, and they don't
render as nicely as just using a link.
@cpu cpu self-assigned this Jul 6, 2024
Copy link

codecov bot commented Jul 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.30%. Comparing base (056e987) to head (3a8d165).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #268   +/-   ##
=======================================
  Coverage   97.30%   97.30%           
=======================================
  Files          19       19           
  Lines        4237     4237           
=======================================
  Hits         4123     4123           
  Misses        114      114           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cpu cpu added this pull request to the merge queue Jul 6, 2024
Merged via the queue into rustls:main with commit fac0431 Jul 6, 2024
30 checks passed
@cpu cpu deleted the cpu-rustdoc-nightly-fix branch July 6, 2024 19:04
@notriddle
Copy link

Just to be clear, you got a warning because you were missing a colon. The footnote could have been fixed this way:

-[^1] <https://www.rfc-editor.org/rfc/rfc5280#section-5.3.1>
+[^1]: <https://www.rfc-editor.org/rfc/rfc5280#section-5.3.1>

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

Successfully merging this pull request may close these issues.

3 participants