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

Add docstrings to all of the public pyhf.utils API #349

Open
4 tasks
matthewfeickert opened this issue Oct 30, 2018 · 0 comments
Open
4 tasks

Add docstrings to all of the public pyhf.utils API #349

matthewfeickert opened this issue Oct 30, 2018 · 0 comments
Assignees
@matthewfeickert
Labels
docs Documentation related

Comments

@matthewfeickert
Copy link
Member

matthewfeickert commented Oct 30, 2018 •
edited
Loading

Description

Docstrings with mathematical explanation and doctest testable examples should be added for all the public members of the pyhf.utils API.

  • Add docstring to all functions meant to be public facing
    • Add mathematical description with relevant equation numbers from arXiv:1007.1727
    • Add example that doctest can run over
  • Change \textrm to \mathrm everywhere
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matthewfeickert matthewfeickert

Labels
docs Documentation related
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@matthewfeickert