You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
result_parameters
analysis option and that they render correctly in the docs.result_parameters
field whenever it's rendered on an API page that this is how you access analysis results.The text was updated successfully, but these errors were encountered: