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

Include model.config property in the pyhf.pdf.Model API documentation #1982

Closed
alexander-held opened this issue Sep 3, 2022 · 1 comment · Fixed by #1972
Closed

Include model.config property in the pyhf.pdf.Model API documentation #1982

alexander-held opened this issue Sep 3, 2022 · 1 comment · Fixed by #1972
Assignees
Labels
docs Documentation related

Comments

@alexander-held
Copy link
Member

alexander-held commented Sep 3, 2022

I would also suggest somehow pointing to _ModelConfig from the pyhf.pdf.Model page. The .config API is not listed there, and it is not particularly intuitive for a user to look at _ModelConfig to find out about that .config attribute, where it says

_ModelConfig should not be called directly. It should instead by accessed through the config attribute of Model

Given that _ModelConfig implies internal API, I wonder whether all of this page should just live within the Model API documentation page? This is where I would expect a user to look for it.

Originally posted by @alexander-held in #1972 (review)

@kratsg kratsg self-assigned this Sep 3, 2022
@kratsg kratsg added the docs Documentation related label Sep 3, 2022
@kratsg
Copy link
Contributor

kratsg commented Sep 3, 2022

Given that _ModelConfig implies internal API, I wonder whether all of this page should just live within the Model API documentation page? This is where I would expect a user to look for it.

This part requires a larger rewrite of how we set up documentation. We currently set it up with one class per page (autoclass/autodoc). We'll probably change the way we do it in the future. But for now, this can be done by just linking to _ModelConfig.

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 a pull request may close this issue.

2 participants