Repository navigation
Fix broken docstring rendering in Linear and RNN - #3890
Merged
Merged
Conversation
nastya236
approved these changes
Jul 22, 2026
|
Yooo whats up Ayaan big fan man |
1 task done
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
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.
Proposed changes
Two small docstring rendering fixes, no behavior change:
Linear: the docstring had a duplicatedwhere:line (a barewhere:immediately followed bywhere :math:\W` has shape ...`), so it rendered "where:" twice. Removed the stray line.RNN: thenonlinearityarg wrotefunc:\tanh`without the leading colon, so Sphinx rendered it literally instead of as a:func:cross-reference. Fixed to:func:`tanh``.Checklist
Put an
xin the boxes that apply.pre-commit run --all-filesto format my code / installed pre-commit prior to committing changes(docstring-only, no tests needed)
small disclaimer: i'm a freshman contributor and i used Claude Code to help me sweep for docstring issues, but i read both docstrings myself to confirm these actually render wrong before opening this. let me know if anything looks off :)