feat(docs): Patch asn.1 doc comments even more#49
Merged
Conversation
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
2 participants
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.
About this PR
The docs.rs output put "@category" and "@revision" lines in one HTML line since markdown requires a blank line to do a paragraph. So we need to add "\n\n" in front of those things.
Also the "@field" lines can be formatted as a list.
Additionally some doc comments were patched in the ASN.1. sources so that they are more consistent with the rest (no "@brief").
For the "@field" lists it would be nice to not have a blank line in between them, but since the source material is not formatted consistently it'll be hard to do that automatically. In the HTML it's only changes if the list items are enclosed in a paragraph tag or not. It doesn't change the rendering at all.