Minor docs improvements #173
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
I don't believe it would make sense to have a separate entry for __radd__.
- Use a verbal sentence for the first line. - Provide an example, with the same values as in __mul__ - Show the equivalence to __mul__ (same as scale_by)
- Use the imperative form in the description. - Simplify the __mul__ example by using an assert
- Use the imperative form in the description. - Simplify the examples showing the equivalence with dot and scale_by: use an assert rather than assume people notice the same value is produced. - Add a reference to __truediv__
This feels more consistent, as it's not very helpful anyhow to know the choice of unit without knowing the coordinate system (i.e. the direction angles go in).
bors bot
added a commit
that referenced
this pull request
Jun 20, 2019
173: Minor docs improvements r=astronouth7303 a=nbraud - Document `__bool__`. - Document in `__add__` and `__mul__` that the reverse operator (`vector-like op vector`) also exists. - Use the imperative form in short-form descriptions (i.e. the docstring's first line). - Use asserts in examples where relevant, rather than showing `True` or implicitly expecting users to notice an equality. - Other minor changes. Co-authored-by: Nicolas Braud-Santoni <nicolas@braud-santoni.eu>
Build failed
|
|
bors retry |
bors bot
added a commit
that referenced
this pull request
Jun 20, 2019
173: Minor docs improvements r=astronouth7303 a=nbraud - Document `__bool__`. - Document in `__add__` and `__mul__` that the reverse operator (`vector-like op vector`) also exists. - Use the imperative form in short-form descriptions (i.e. the docstring's first line). - Use asserts in examples where relevant, rather than showing `True` or implicitly expecting users to notice an equality. - Other minor changes. Co-authored-by: Nicolas Braud-Santoni <nicolas@braud-santoni.eu>
Build succeeded
|
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.
__bool__.__add__and__mul__that the reverse operator (vector-like op vector) also exists.Trueor implicitly expecting users to notice an equality.