Skip to content
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

Merged
merged 8 commits into from
Jun 22, 2022

Conversation

Saransh-cpp
Copy link
Member

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!

@Saransh-cpp Saransh-cpp marked this pull request as draft May 29, 2022 06:52
@Saransh-cpp Saransh-cpp marked this pull request as ready for review May 29, 2022 09:08
@Saransh-cpp Saransh-cpp changed the title docs: add docstrings in the _backends.numpy_ module docs: add docstrings in the backends.numpy module Jun 10, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #195 (4c8f63b) into main (5387e5e) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #195   +/-   ##
=======================================
  Coverage   82.44%   82.44%           
=======================================
  Files          96       96           
  Lines       10386    10387    +1     
=======================================
+ Hits         8563     8564    +1     
  Misses       1823     1823           
Impacted Files Coverage Δ
src/vector/backends/numpy.py 77.50% <100.00%> (+0.02%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5387e5e...4c8f63b. Read the comment docs.

Copy link
Member

@henryiii henryiii left a 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!

@Saransh-cpp Saransh-cpp merged commit df14f00 into scikit-hep:main Jun 22, 2022
@Saransh-cpp Saransh-cpp deleted the saransh/add-docstrings branch June 22, 2022 07:51
@Saransh-cpp Saransh-cpp added this to the v0.9.0 milestone Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants