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

Add Pauli Network pass info #2263

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

victor-villar
Copy link

Closes #2258

Adding Pauli Network docuemntation.

@CLAassistant
Copy link

CLAassistant commented Nov 7, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@cbjuan cbjuan left a comment

Choose a reason for hiding this comment

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

1st minimal review. We should mention the Pauli Networks in https://github.com/Qiskit/documentation/pull/2263/files#diff-a437d90d2e8ccfb2188262ffd1ae5f172429f9bdab26543e4852d8b5c46676ffR57. Typically we mention the name of the supported circuits and introduce a link from Qiskit documentation that could help to understand the type of circuit referenced.

@@ -23,6 +23,7 @@ The following passes are currently available:
- `AICliffordSynthesis`: Clifford circuit synthesis
- `AILinearFunctionSynthesis`: Linear function circuit synthesis
- `AIPermutationSynthesis`: Permutation circuit synthesis
- `AIPauliNetworkSynthesis`: Pauli Network circuit synthesis
Copy link
Collaborator

@abbycross abbycross Nov 11, 2024

Choose a reason for hiding this comment

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

Is it essential to capitalize Network (when it's not in code font)? I'm ok with it if we stay consistent, though our general guidelines are to keep things lowercase unless branded or a product name (or are officially capitalized elsewhere in the world) 🌎

Copy link
Member

Choose a reason for hiding this comment

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

In this case it should be capitalized to be coherent with the class name available in the code

@qiskit-bot
Copy link
Contributor

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

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
5 participants