astxml2markdown.xslt: Change processing of "note" and "warning" #66
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
gtjoseph
force-pushed
the
main-fix-api-note
branch
from
554cff7 to
34ba763
Compare
gtjoseph
changed the title
Member
|
I barely speak XSLT, does anyone else? |
gtjoseph
force-pushed
the
main-fix-api-note
branch
2 times, most recently
from
7a9300a to
b835b9d
Compare
seanbright
reviewed
Mar 12, 2024
Member
Author
|
@seanbright While I'm here... The "replaceable" elements are currently rendered as italic. Do you think maybe monospaced is better? The |
gtjoseph
force-pushed
the
main-fix-api-note
branch
from
b835b9d to
879927f
Compare
Contributor
|
I think |
Member
Author
|
Admonitions used inside lists were throwing off the list rendering and making a mess. * Changed to the pymarkdown-blocks style admonitions which use `/// <admonition>` and, more importantly, use a closing delimiter of `///`. * Added blank lines before every list item to get around another issue where list indentation was getting reset. * Fixed indentation in example blocks. Resolves: asterisk#65
gtjoseph
force-pushed
the
main-fix-api-note
branch
from
879927f to
f9dbef1
Compare
seanbright
approved these changes
Mar 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Using admonitions for notes and warnings in the API documentation
resulted in bad formatting when used in parameter lists or enums.
Instead we now just leave them in-line and wrapped with
**Info: <text>**or**Warning: <text>**.Resolves: #65