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 typehint aliases #1969

Merged
merged 5 commits into from
Aug 29, 2022
Merged

Conversation

kratsg
Copy link
Contributor

@kratsg kratsg commented Aug 29, 2022

Pull Request Description

Resolves #1964.

Link to docs render: https://pyhf--1969.org.readthedocs.build/en/1969/_generated/pyhf.tensor.numpy_backend.numpy_backend.html#pyhf.tensor.numpy_backend.numpy_backend

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 Sphinx autodoc typehint aliases to improve readability of documentation.
   - c.f. https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_type_aliases

@kratsg kratsg added the docs Documentation related label Aug 29, 2022
@kratsg kratsg self-assigned this Aug 29, 2022
@codecov
Copy link

codecov bot commented Aug 29, 2022

Codecov Report

Merging #1969 (222d3ab) into master (62aad71) will decrease coverage by 0.13%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1969      +/-   ##
==========================================
- Coverage   98.24%   98.10%   -0.14%     
==========================================
  Files          68       68              
  Lines        4377     4378       +1     
  Branches      726      726              
==========================================
- Hits         4300     4295       -5     
- Misses         45       48       +3     
- Partials       32       35       +3     
Flag Coverage Δ
contrib 26.58% <100.00%> (+0.01%) ⬆️
doctest 60.57% <100.00%> (+<0.01%) ⬆️
unittests-3.10 96.13% <100.00%> (+<0.01%) ⬆️
unittests-3.7 ?
unittests-3.8 ?
unittests-3.9 ?

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

Impacted Files Coverage Δ
src/pyhf/tensor/numpy_backend.py 98.59% <100.00%> (+<0.01%) ⬆️
src/pyhf/schema/variables.py 75.00% <0.00%> (-25.00%) ⬇️
src/pyhf/schema/loader.py 90.90% <0.00%> (-9.10%) ⬇️
src/pyhf/utils.py 91.83% <0.00%> (-4.09%) ⬇️

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

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.

LGTM. 👍 Thanks @kratsg!

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.

Improve typing rendering in docs
2 participants