Skip to content

docs: add docstrings for Op.free_symbols, Op.get_unitary, Op.is_gate - #2252

Open
coruspus-999 wants to merge 1 commit into
Quantinuum:mainfrom
coruspus-999:fix/1380-op-docstrings
Open

coruspus-999 wants to merge 1 commit into
Quantinuum:mainfrom
coruspus-999:fix/1380-op-docstrings

Conversation

@coruspus-999

Copy link
Copy Markdown

Fixes #1380

Add missing docstrings for Op.free_symbols, Op.get_unitary, and Op.is_gate methods in pytket.circuit.Op.

The added docstrings explain:

  • free_symbols: Returns the set of free symbols in the operation parameters
  • get_unitary: Returns the unitary matrix representation of the operation
  • is_gate: Returns True if the operation is a gate (as opposed to a measurement, reset, or other non-gate operation)

Developed with AI assistance; reviewed and tested by me.

Fixes Quantinuum#1380

Add missing docstrings for Op.free_symbols, Op.get_unitary, and Op.is_gate
methods in pytket.circuit.Op as requested in issue Quantinuum#1380.

Signed-off-by: Coruspus-999 <vempa457914@gmail.com>

@cqc-alec cqc-alec left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the PR. You seem to have introduced a lot of spurious special characters in places that are outside the scope of the PR. Please can you revert those changes?

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document all methods and properties for pytket.circuit.Op

3 participants