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

Dependency #280

Merged
merged 10 commits into from
Oct 28, 2022
Merged

Dependency #280

merged 10 commits into from
Oct 28, 2022

Conversation

Naman-Priyadarshi
Copy link
Contributor

@Naman-Priyadarshi Naman-Priyadarshi commented Oct 19, 2022

Description

Kindly take a look at CONTRIBUTING.md.

I was working on another issue when i found out that papermill (tool for parameterizing and executing Jupyter Notebooks) was missing during pytest. The module is used in the notebook.yml workflow file.

Checklist

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't any other open Pull Request for the required change ?
  • Does your submission pass pre-commit? ($ pre-commit run --all-files or $ nox -s lint)
  • Does your submission pass tests? ($ pytest or $ nox -s tests)
  • Does the documentation build with your changes? ($ cd docs; make clean; make html or $ nox -s docs)
  • Does your submission pass doctests? ($ xdoctest ./src/vector or $ nox -s doctests)

Before Merging

  • Summarize commit messages into a brief review of the Pull request.

@codecov-commenter
Copy link

codecov-commenter commented Oct 19, 2022

Codecov Report

Base: 81.08% // Head: 81.08% // No change to project coverage 👍

Coverage data is based on head (74c3232) compared to base (4fbbd81).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #280   +/-   ##
=======================================
  Coverage   81.08%   81.08%           
=======================================
  Files          96       96           
  Lines       10672    10672           
=======================================
  Hits         8653     8653           
  Misses       2019     2019           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Saransh-cpp Saransh-cpp self-requested a review October 19, 2022 14:49
@Saransh-cpp Saransh-cpp added tests More or better tests are needed dependencies Pull requests that update a dependency file labels Oct 19, 2022
@Saransh-cpp Saransh-cpp added this to the v1.0.0 milestone Oct 19, 2022
Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @Naman-Priyadarshi! We should also -

  • add this to dev dependencies
  • update the section on testing in contributing.md to reflect notebook tests

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @Naman-Priyadarshi! Could you also add something like - "To skip the notebook tests, use `--ignore=tests/test_notebooks.py." below -

Running tests locally

The tests can be executed using the test and test-extras dependencies of vector in the following way -

python -m pytest

@@ -122,6 +122,14 @@ xdoctest ./src/vector/

A much more detailed guide on testing with `pytest` for `Scikit-HEP` packages is available [here](https://scikit-hep.org/developer/pytest).

### Running doctests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Running doctests
### Running notebook tests

@Saransh-cpp Saransh-cpp merged commit 5a4f845 into scikit-hep:main Oct 28, 2022
@Naman-Priyadarshi Naman-Priyadarshi deleted the dependency branch November 4, 2022 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file tests More or better tests are needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants