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

Clearly mark analysis result names in documentation #1400

Open
coruscating opened this issue Feb 8, 2024 · 0 comments
Open

Clearly mark analysis result names in documentation #1400

coruscating opened this issue Feb 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@coruscating
Copy link
Collaborator

With the deprecation of accessing analysis results via numerical indices in #1342, it's important to clearly list the name of analysis results so users know how to retrieve their results. For example, you can't tell on the CrossResonanceHamiltonianAnalysis page what the name of the result is. Ideally the minimal examples in #1171 would contain examples for retrieving analysis results by name, but it should also be clearly documented in the analysis docs. I think two things need to be done:

  • Check that every analysis class has the name listed in the result_parameters analysis option and that they render correctly in the docs.
  • Add a note to the result_parameters field whenever it's rendered on an API page that this is how you access analysis results.
@coruscating coruscating added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 8, 2024
@coruscating coruscating added this to the Release 0.7 milestone Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant