Skip to content

Revise decorators to allow for docstring rendering #673

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
Open
matthewfeickert opened this issue Dec 6, 2019 · 1 comment
Open

Revise decorators to allow for docstring rendering #673

matthewfeickert opened this issue Dec 6, 2019 · 1 comment
Labels
bug Something isn't working docs Documentation related follow up good first issue Good for newcomers

Comments

@matthewfeickert
Copy link
Member

Description

All functions that are currently wrapped by decorators (such as pyhf.set_backend) are unable to produce proper docstrings that can be rendered by Sphinx. As outlined in this post by Hynek Schlawack a solution would to be to use something like wrapt to avoid this.

This should be investigated to make sure the API is properly documented on the website.
@matthewfeickert matthewfeickert added bug Something isn't working good first issue Good for newcomers follow up docs Documentation related labels Dec 6, 2019
@kratsg
Copy link
Contributor

kratsg commented Oct 23, 2020

See #1124 and #984.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working docs Documentation related follow up good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kratsg @matthewfeickert