Format synthesis docs #11755
Merged
Format synthesis docs #11755
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ElePT
added
documentation
ElePT
requested review from
alexanderivrii,
ShellyGarion and
a team
as code owners
|
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 7909082546Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
jakelishman
reviewed
Feb 8, 2024
jakelishman
added
the
stable backport potential
Co-authored-by: Jake Lishman <jake@binhbar.com>
ShellyGarion
reviewed
Feb 8, 2024
ElePT
commented
Feb 8, 2024
ElePT
force-pushed
the
synthesis-docs
branch
from
a26e044
to
88181da
Compare
Cryoris
reviewed
Feb 13, 2024
Co-authored-by: Evgenii Zheltonozhskii <zheltonozhskiy@gmail.com>
Inline typehints for synth docs
ElePT
force-pushed
the
synthesis-docs
branch
from
38f0f6f
to
98d123d
Compare
jakelishman
reviewed
Feb 15, 2024
jakelishman
approved these changes
Feb 15, 2024
There was a problem hiding this comment.
Thanks for all this Elena and everyone else who read through and helped find fixes. I imagine we could probably keep making changes to the documentation forever if we try, so I propose we merge this PR as-is now so it lands for 1.0.0 final, and we can open new PRs to fix up more things if we need to later.
mergify bot
pushed a commit
that referenced
this pull request
Feb 15, 2024
* Format synthesis docs. * Apply suggestions from Jake's code review Co-authored-by: Jake Lishman <jake@binhbar.com> * Apply rest of review comments * Fix lint, latexify ~ * Apply suggestions from code review * Revert bug in TwoQubitWeylfSimabmbEquiv * Apply inline suggestions from Julien's code review Co-authored-by: Julien Gacon <gaconju@gmail.com> * Finish applying Julien's suggestions * Apply suggestions from Shelly's code review * inline typehints for synth docs * Update qiskit/synthesis/clifford/clifford_decompose_ag.py Co-authored-by: Evgenii Zheltonozhskii <zheltonozhskiy@gmail.com> * Apply review comments from Shelly * Make lint happy? * Fix black * Remove unnecessary indentation * Fix backslash in non-raw string --------- Co-authored-by: Jake Lishman <jake@binhbar.com> Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: Julien Gacon <jules.gacon@googlemail.com> Co-authored-by: Evgenii Zheltonozhskii <zheltonozhskiy@gmail.com> (cherry picked from commit 694de7c)
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 15, 2024
* Format synthesis docs. * Apply suggestions from Jake's code review Co-authored-by: Jake Lishman <jake@binhbar.com> * Apply rest of review comments * Fix lint, latexify ~ * Apply suggestions from code review * Revert bug in TwoQubitWeylfSimabmbEquiv * Apply inline suggestions from Julien's code review Co-authored-by: Julien Gacon <gaconju@gmail.com> * Finish applying Julien's suggestions * Apply suggestions from Shelly's code review * inline typehints for synth docs * Update qiskit/synthesis/clifford/clifford_decompose_ag.py Co-authored-by: Evgenii Zheltonozhskii <zheltonozhskiy@gmail.com> * Apply review comments from Shelly * Make lint happy? * Fix black * Remove unnecessary indentation * Fix backslash in non-raw string --------- Co-authored-by: Jake Lishman <jake@binhbar.com> Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: Julien Gacon <jules.gacon@googlemail.com> Co-authored-by: Evgenii Zheltonozhskii <zheltonozhskiy@gmail.com> (cherry picked from commit 694de7c) Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds missing format (API docs links, code formatting) found in different synthesis docstrings during the review of #11719. All minor fixes (low priority), but would be nice to get into the 1.0 docs if possible.
Details and comments