-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add docstrings in the backends.numpy
module
#195
docs: add docstrings in the backends.numpy
module
#195
Conversation
_backends.numpy_
modulebackends.numpy
module
Codecov Report
@@ Coverage Diff @@
## main #195 +/- ##
=======================================
Coverage 82.44% 82.44%
=======================================
Files 96 96
Lines 10386 10387 +1
=======================================
+ Hits 8563 8564 +1
Misses 1823 1823
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GetItem
is a mixin that provides the infrastructure for []
access. These are implementation details so don't think it's critical to have good docs for them. The rest is an improvement!
I have tried to add docstrings for both developers and users. #194 blocked the addition of examples to some properties, but I will definitely add them once the issue is closed. I have skipped some functions and classes as I couldn't properly understand what they were doing. These are -
def _getitem
def _setitem
class GetItem
Please let me know if I should add some more context in the docstrings or if any changes are required!
Note: The class variables are rendered in the documentation with their values automatically. Hence, I decided not to add docstrings for them, but I would be more than happy to override the automatically rendered stuff!