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

fix: Skip doctest of pyhf.contrib.utils.download #1715

Merged

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Nov 30, 2021

Description

Resolves #1714

Use the doctest SKIP directive to skip evaluation of all pyhf.contrib.utils.download related commands in the docstring example to avoid reliance on HEPData for testing. Along with PRs #1697, #1704, and #1711, this should remove all direct usage of HEPData infrastructure for testing.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Use the doctest SKIP directive to skip commands related to
pyhf.contrib.utils.download in its docstring example to remove
reliance on HEPData infrastructure for testing.
   - c.f. https://docs.python.org/3/library/doctest.html#doctest.SKIP

@matthewfeickert matthewfeickert added docs Documentation related tests pytest fix A bug fix labels Nov 30, 2021
@matthewfeickert matthewfeickert self-assigned this Nov 30, 2021
@codecov
Copy link

codecov bot commented Nov 30, 2021

Codecov Report

Merging #1715 (7636a69) into master (b9af390) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1715   +/-   ##
=======================================
  Coverage   98.12%   98.12%           
=======================================
  Files          64       64           
  Lines        4269     4269           
  Branches      594      682   +88     
=======================================
  Hits         4189     4189           
  Misses         46       46           
  Partials       34       34           
Flag Coverage Δ
contrib 26.25% <ø> (ø)
doctest 60.59% <ø> (-0.22%) ⬇️
unittests 96.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/pyhf/contrib/utils.py 100.00% <ø> (ø)

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 b9af390...7636a69. Read the comment docs.

@matthewfeickert matthewfeickert merged commit 6103f13 into master Nov 30, 2021
@matthewfeickert matthewfeickert deleted the docs/skip-testing-contrib-download-example-docstring branch November 30, 2021 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related fix A bug fix tests pytest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove dependency on HEPData from docstring tests
2 participants