rustls / webpki

WebPKI X.509 Certificate Validation in Rust
https://docs.rs/rustls-webpki/latest/webpki/
Other
94 stars 50 forks source link

types: avoid markdown footnotes #268

Closed cpu closed 3 months ago

cpu commented 3 months ago

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

Fixes build errors on main.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

notriddle commented 2 months ago

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>