Skip to content

Conversation

@abbycross
Copy link
Collaborator

@abbycross abbycross commented Dec 19, 2025

Closes #4437

Also brings in changes by external contributor in #4421 - including here so that checks will pass

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@qiskit-bot
Copy link
Contributor

One or more of the following people are relevant to this code:

…4421)

In the documentation, multiple objects of a class were sometimes
referred to using the style "`MyClass`s".
This PR updates these references to "`MyClass` objects" to fix
translation problems in documentation.

This addresses the part of #2067 for `/guides`.

---------

Co-authored-by: abbycross <across@us.ibm.com>
Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this!

"metadata": {},
"source": [
"To view execution span information, review the metadata of the result returned by `SamplerV2`, which comes in the form of an `ExecutionSpans` object. This object is a list-like container containing subclass instances of `ExecutionSpan`s such as `SliceSpan`:"
"To view execution span information, review the metadata of the result returned by `SamplerV2`, which comes in the form of an `ExecutionSpans` object. This object is a list-like container containing instances of subclasses of `ExecutionSpan`, such as `SliceSpan`:"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"To view execution span information, review the metadata of the result returned by `SamplerV2`, which comes in the form of an `ExecutionSpans` object. This object is a list-like container containing instances of subclasses of `ExecutionSpan`, such as `SliceSpan`:"
"To view execution span information, review the metadata of the result returned by `SamplerV2`, which comes in the form of an `ExecutionSpans` object. This object is a list-like container containing instances of subclasses of `ExecutionSpan`, such as `SliceSpan`:"

}
],
"source": [
"# Include the two commented-out lines if you are not using Python in a Jupyter notebook\n",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hot take: what do you think about duplicating the comment? I find instructions get confusing when spread out over too many lines, like "wait which lines?" Ack that it could be overkill here though because we have so few lines

Actually, maybe better idea: move the import right before plt.show(), so the two line are right next to each other. Imports don't technically have to be at the very top of the file. (Although this may make a linter mad).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good points! Yet another option would be to be very explicit as to what to do, as in: "Uncomment lines x and y...". I wouldn't like to refer to specific line numbers in "normal" code, but a web snippet is another thing.

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

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Missing import matplotlib.pyplot as plt line

5 participants