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

Documentation for cirq.Circuit.prev_moment_operating_on is incorrect #4894

Closed
perlinm opened this issue Jan 25, 2022 · 1 comment
Closed
Labels
kind/bug-report Something doesn't seem to work.

Comments

@perlinm
Copy link
Contributor

perlinm commented Jan 25, 2022

Description of the issue

The docstring summaries for cirq.Circuit.next_moment_operating_on and cirq.Circuit.prev_moment_operating_on are identical: both say "Finds the index of the next moment that touches the given qubits."

The docstring for cirq.Circuit.prev_moment_operating_on should either say "Finds the index of the previous moment that touches the given qubits.", or else somehow specify that "next" means "next in a search backwards through the circuit".

How to reproduce the issue

See links above, or examine docstring via

help(cirq.Circuit.prev_moment_operating_on)

Cirq version

Issue identical in cirq versions 0.13.1 and 0.14.0.dev20220105215702

@perlinm perlinm added the kind/bug-report Something doesn't seem to work. label Jan 25, 2022
CirqBot pushed a commit that referenced this issue Jan 25, 2022
See #4894 concerning a single-word documentation error for `cirq.Circuit.prev_moment_operating_on`
@vtomole
Copy link
Collaborator

vtomole commented Jan 25, 2022

Closed by #4895.

@vtomole vtomole closed this as completed Jan 25, 2022
rht pushed a commit to rht/Cirq that referenced this issue May 1, 2023
…mlib#4895)

See quantumlib#4894 concerning a single-word documentation error for `cirq.Circuit.prev_moment_operating_on`
harry-phasecraft pushed a commit to PhaseCraft/Cirq that referenced this issue Oct 31, 2024
…mlib#4895)

See quantumlib#4894 concerning a single-word documentation error for `cirq.Circuit.prev_moment_operating_on`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug-report Something doesn't seem to work.
Projects
None yet
Development

No branches or pull requests

2 participants