Repository navigation
Fix doubled-word typos in docstrings - #3561
Merged
Merged
Conversation
Five instances of 'the the'/'is is' in user-visible Python and C++ docstrings: - python/mlx/nn/losses.py: gaussian_nll_loss docstring - python/mlx/nn/layers/distributed.py: AllToShardedLinear and ShardedToAllLinear bias arg docs (two copies) - python/src/ops.cpp: logaddexp docstring - python/src/transforms.cpp: compile() return-value docstring
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.
Summary
Five trivial doubled-word typos in user-visible docstrings:
python/mlx/nn/losses.pygaussian_nll_lossdocstring: "are the the predicted variances" → "are the predicted variances"python/mlx/nn/layers/distributed.pyAllToShardedLinear/ShardedToAllLinearbias arg: "If set toFalsethe the layer will not use a bias" → "the layer will not use a bias"python/src/ops.cpplogaddexpdocstring: "The computation is is a numerically stable version" → "The computation is a numerically stable version"python/src/transforms.cppcompile()return-value docstring: "returns the the same output(s)" → "returns the same output(s)"Test plan
python3 -c "import ast; ast.parse(open('python/mlx/nn/losses.py').read()); ast.parse(open('python/mlx/nn/layers/distributed.py').read())"— both files still parse.grep -rEn '\b(the the|of of|is is|to to|and and|that that|in in|a a)\b' --include='*.py' --include='*.cpp' --include='*.h' python/— no remaining hits in user-visible code.Scope
Docstring text only. No code, behavior, or API affected.