Minor updates to the vector demo #24853
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
Contributor
rhettinger
commented
Mar 14, 2021
rhettinger
commented
- Have repr follow best practices and not hardwire the class name.
- Convert comments to docstrings.
- Enhance the demo with one non-dunder method, a dot product.
* __repr__ to follow best practices and not hardwire the class name. * Convert comments to docstrings. * Enhance the demo with one non-dunder method, a dot product.
| @@ -50,22 +56,28 @@ def __getitem__(self, i): | |||
| return self.v[i] | |||
|
|
|||
| def __add__(self, other): | |||
| # Element-wise addition | |||
| "Element-wise addition" | |||
There was a problem hiding this comment.
Isn't best practise triple quotes for docstrings? Ref. PEP 8/documentation-strings
There was a problem hiding this comment.
We're somewhat loose about this. The original rationale was that it would save you from retyping the quotes if the docstring grew to multiple lines. That isn't a likely possibility here.
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.