docs(nnx): fill missing docstrings in variables/rnglib, fix helpers g… - #5545
Open
greekera1000 wants to merge 1 commit into
Open
docs(nnx): fill missing docstrings in variables/rnglib, fix helpers g…#5545greekera1000 wants to merge 1 commit into
greekera1000 wants to merge 1 commit into
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
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.
What does this PR do?
More docstring fixes for the NNX API reference (part of #5161):
with_metadatahad no docstring, so it rendered as a bare signature in the reference — added one with a working example.RngStreaminherited the generic Pytree docstring ("Base class for all NNX objects.") in the reference — added a proper one.ListandDictdocstrings.Scope: docs + docstrings only, no behavioral changes. Doctests for the touched modules pass locally.
Relates to #5161.
Checklist