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.

Sign up for GitHub

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

Jump to bottom

docs: Add readxml and writexml #1242

Merged
merged 5 commits into from
Jan 5, 2021
Merged

docs: Add readxml and writexml #1242

merged 5 commits into from
Jan 5, 2021

Conversation

kratsg
Copy link
Contributor

@kratsg kratsg commented Jan 5, 2021 •
edited by matthewfeickert
Loading

Pull Request Description

This needs #1002. Add readxml and writexml to our documented API. Resolves #1131.

Related issue: #943.

ReadTheDocs build: https://pyhf.readthedocs.io/en/docs-importexport/api.html#top-level

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 readxml and writexml to docs API
* Add template for autosummary module to render classes/functions properly
* Update [docs] option for installation to depend on [xmlio]
* Teach RTD to fail on warnings (be more strict)

@kratsg kratsg added the docs Documentation related label Jan 5, 2021
@kratsg kratsg self-assigned this Jan 5, 2021
@codecov
Copy link

codecov bot commented Jan 5, 2021 •
edited
Loading

Codecov Report

Merging #1242 (dc2f9a4) into master (e3da2dc) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1242   +/-   ##
=======================================
  Coverage   97.47%   97.47%           
=======================================
  Files          63       63           
  Lines        3716     3716           
  Branches      525      525           
=======================================
  Hits         3622     3622           
  Misses         55       55           
  Partials       39       39
Flag Coverage Δ
unittests 97.47% <ø> (ø)

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

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 e3da2dc...dc2f9a4. Read the comment docs.

@kratsg kratsg added the chore Other changes that don't modify src or test files label Jan 5, 2021
matthewfeickert
matthewfeickert approved these changes Jan 5, 2021
View reviewed changes
Copy link
Member

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

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

@kratsg LGTM! Once you get the RTD link building again as expected I'm happy with this.

It also nicely finds some problems we had with docstrings in other areas, so this is good (I'll fix in another PR)!

@kratsg kratsg merged commit 93104ad into master Jan 5, 2021
@kratsg kratsg deleted the docs/importexport branch January 5, 2021 17:48
@matthewfeickert matthewfeickert mentioned this pull request Jan 5, 2021
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthewfeickert matthewfeickert matthewfeickert approved these changes

@lukasheinrich lukasheinrich Awaiting requested review from lukasheinrich

Assignees

@kratsg kratsg

Labels
chore Other changes that don't modify src or test files docs Documentation related
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add pyhf.writexml and pyhf.readxml to public API docs
2 participants
@kratsg @matthewfeickert