Skip to content

[API docs] Fix Moment API docs. #5506

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 13, 2022
Merged

[API docs] Fix Moment API docs. #5506

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d390ac0
[API docs] Fix Moment API docs.
MichaelBroughton Jun 13, 2022
5eecb4c
Adam feedback.
MichaelBroughton Jun 13, 2022
c3ee059
Merge branch 'master' into moment_docs
CirqBot Jun 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion cirq-core/cirq/circuits/moment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,18 @@ def transform_qubits(
return self.__class__(op.transform_qubits(qubit_map) for op in self.operations)

def expand_to(self, qubits: Iterable['cirq.Qid']) -> 'cirq.Moment':
"""Returns self expanded to given superset of qubits by making identities explicit."""
"""Returns self expanded to given superset of qubits by making identities explicit.

Args:
qubits: Iterable of `cirq.Qid`s to expand this moment to.

Returns:
A new `cirq.Moment` with identity operations on the new qubits
not currently found in the moment.

Raises:
ValueError: if this moments' qubits are not a subset of `qubits`.
"""
if not self.qubits.issubset(qubits):
raise ValueError(f'{qubits} is not a superset of {self.qubits}')

Expand Down