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 to _ModelConfig methods #1420

Merged
merged 6 commits into from
Apr 29, 2021

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Apr 28, 2021

Description

To satisfy pydocstyle in PR #1403 docstrings need to be added to pyhf.pdf._ModelConfig, so these are added here.

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
* Add docstrings and examples to pyhf.pdf._ModelConfig and its methods

@matthewfeickert matthewfeickert added the docs Documentation related label Apr 28, 2021
@matthewfeickert matthewfeickert self-assigned this Apr 28, 2021
@matthewfeickert
Copy link
Member Author

@codecov
Copy link

codecov bot commented Apr 28, 2021

Codecov Report

Merging #1420 (3c1145c) into master (2efe0d2) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1420   +/-   ##
=======================================
  Coverage   97.58%   97.58%           
=======================================
  Files          63       63           
  Lines        3886     3886           
  Branches      555      555           
=======================================
  Hits         3792     3792           
  Misses         55       55           
  Partials       39       39           
Flag Coverage Δ
contrib 25.03% <ø> (ø)
unittests 97.34% <ø> (ø)

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

Impacted Files Coverage Δ
src/pyhf/pdf.py 96.40% <ø> (ø)

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 2efe0d2...3c1145c. Read the comment docs.

@matthewfeickert matthewfeickert force-pushed the docs/add-docstrings-to-model-config branch from ee3669d to 7bad50f Compare April 29, 2021 05:34
@kratsg kratsg merged commit 487ea54 into master Apr 29, 2021
@kratsg kratsg deleted the docs/add-docstrings-to-model-config branch April 29, 2021 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants