crl: avoid markdown footnotes #284
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nightly rustdoc flags these as non-standard markdown, and they don't render as nicely as just using a link.
djc
approved these changes
Jul 7, 2024
|
Since this is docs only I'm going to merge with one positive review. Happy to iterate if there's any additional feedback. |
|
Just to be clear, you got a warning because you forgot the -[^1] <https://www.rfc-editor.org/rfc/rfc5280#section-5.3.1>
+[^1]: <https://www.rfc-editor.org/rfc/rfc5280#section-5.3.1>If you want to use footnotes and have them continue to work, try writing the Markdown you want in a GitHub comment and see if the preview tab looks right. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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, rustls/webpki#268
Fixes build errors on main.