Fixing docstring linter #2163
Merged
Fixing docstring linter #2163
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
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/2163
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit f75c7cd with merge base 9dae7f1 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
SalmanMohammadi
commented
Dec 17, 2024
| ValueError: if ``keys_to_pad`` is empty, or is not a list, or is not a subset of keys in the batch. | ||
| ValueError: if ``padding_idx`` is provided as a dictionary, but the keys are not identical to | ||
| ``keys_to_pad``. | ||
| ValueError: |
There was a problem hiding this comment.
The docstring linter lints based on unique raises, so we document a single value error and each condition it will raise for. Annoyingly, I couldn't for the life of me get lists to properly render in the raises section.
This is what it looks like instead:
joecummings
approved these changes
Jan 14, 2025
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.
Context
What is the purpose of this PR? Is it to
I ran
pre-commit autoupdateto update the repos we use in our pre-commit hooks..-------. * | # | * |_______| * _|=======|_ * * [___________] .' `. * | / : @ @ : \|/_ : < : // \~_s~-~s~s`._`...'_.' // * * `--~-~-~~s~/`"""' `-. // /'/s/ _ `// / /s/ (_) / ///s/ _ : * * ///s/ (_) .' * // |/`. .' __// .-''-------'`-. /|\ .' _ `. * / | \: (_) : : _ : : (_) : * : _ : * : (_) : : : ""'"""'""`. .'"'"""'""'"" `-._ _.-' `"""""'