doc: fix warning documentation HTML tags - #2486
Open
jasonaowen wants to merge 2 commits into
Open
Conversation
In commit 8e54074, the warnings on several `StreamCipher` methods were changed into sections that should have had the `warning` CSS class. Unfortunately, the HTML was malformed, and the resulting documentation rendered the sections as all-bold instead of with the rustdoc warning style. Fix the HTML in the `StreamCipher::unchecked_*` methods.
Resolve rustdoc warnings about unopened HTML tags and unclosed HTML tags by replacing the former with the correct closing tags for the latter. Also add additional spacing between markdown and HTML, as suggested in the rustdoc book[1]. [1] https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#adding-a-warning-block
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fix several rustdoc warnings about HTML tags in warning sections.
Before:
After: