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 do not mention all of the values under pydrad.parse.Profile #174

Open
jwreep opened this issue Oct 23, 2024 · 1 comment
Open

Docs do not mention all of the values under pydrad.parse.Profile #174

jwreep opened this issue Oct 23, 2024 · 1 comment

Comments

@jwreep
Copy link
Member

jwreep commented Oct 23, 2024

After #169, we added a parsing of all the data in the .trm files, but we did not add their descriptions to the Docs.
(https://pydrad.readthedocs.io/en/latest/api/pydrad.parse.Profile.html)

@wtbarnes
Copy link
Member

wtbarnes commented Dec 2, 2024

The reason these are not documented is because the properties associated with the trm data are generated on the fly on import since there are so many of those quantities and they may not exist for each HYDRAD run.

Since these properties are all known (unlike, say, the NEI fractions which vary according to the simulation setup), we could hardcode all of these docstrings similarly to what is done for some of the other properties. This would be overly verbose and would make the parse.py file quite long.

Alternatively, there may be some way to auto-generate these docstrings not at import such that they would be included in the rendered docs. Off the top of my head, I'm not sure how to do this, though I think it is possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants