Refactors several more docs #474
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
- Updates doc generation to allow the caller to distinguish the "output"
and "local variables" sections that are appended after the code. This
allows to have special treatment for those - e.g. local variables in
guides are now collapsible.
- Updates styling for "example" sections to stand out more. Previously, they
were getting lost in all the other text.
- Removes redundant captions.
pranavm-nvidia
force-pushed
the
more-concise-docs
branch
7 times, most recently
from
3f4f0d7 to
f0893d5
Compare
yizhuoz004
approved these changes
Jan 13, 2025
parthchadha
approved these changes
Jan 13, 2025
pranavm-nvidia
force-pushed
the
more-concise-docs
branch
from
f0893d5 to
d9fa8ea
Compare
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.
Improves display of local variables in generated docs
Updates doc generation to allow the caller to distinguish the "output"
and "local variables" sections that are appended after the code. This
allows to have special treatment for those - e.g. local variables in
guides are now collapsible.
Updates styling for "example" sections to stand out more. Previously, they
were getting lost in all the other text.
Removes redundant captions.
Updates various guides/documentation to be more concise
Eliminates the requirement to write redundant captions