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.object module #201

Conversation

Saransh-cpp
Copy link
Member

Added docstrings and minor examples!

@codecov-commenter
Copy link

codecov-commenter commented Jun 12, 2022

Codecov Report

Merging #201 (927e2c8) into main (4fa62e8) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #201   +/-   ##
=======================================
  Coverage   82.44%   82.45%           
=======================================
  Files          96       96           
  Lines       10387    10388    +1     
=======================================
+ Hits         8564     8565    +1     
  Misses       1823     1823           
Impacted Files Coverage Δ
src/vector/backends/object.py 73.07% <100.00%> (+0.01%) ⬆️

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 4fa62e8...927e2c8. 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.

I'd recommend not waiting for a review for more docs. It's always nice to have a second set of eyes, but adding missing docs is not ideal for easy reviewing, so I'd recommend just moving ahead unless you have specific questions.

To clear up something Jim wanted to make sure was clear - you don't "need" a review to merge things here. It's just nice to have a second set of eyes on things; I like to have a review if I can even on my own repos.

@jpivarski
Copy link
Member

That's right—I'll be a second reviewer depending on severity. Of course I like to stay aware of changes and provide feedback, but my backlog is pretty long. You don't need to wait for a review from me to decide to merge.

@Saransh-cpp
Copy link
Member Author

Got it! Thank you for the clarification!

@Saransh-cpp Saransh-cpp merged commit 1a84859 into scikit-hep:main Jun 22, 2022
@Saransh-cpp Saransh-cpp deleted the saransh/add-docstrings-for-object-backend branch June 22, 2022 08:12
@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.

4 participants