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 #38

Open
matthewfeickert opened this issue Jan 31, 2018 · 0 comments
Open

Add docstrings #38

matthewfeickert opened this issue Jan 31, 2018 · 0 comments
Assignees
@matthewfeickert
Labels
docs Documentation related
Projects
pyhf development

Comments

@matthewfeickert
Copy link
Member

The classes and methods of pyhf need docstrings for documentation of the code.

In anticipation of using Sphinx for the docs, the doc strings should follow something along the lines of PyTorch's style (maybe dipping into TensorFlow's style guide at times too). For an example, c.f. PyTorch's Bernoulli distribution.
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
pyhf development
  
To do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@matthewfeickert