Enable repeat use of UCCDefault1 and update docs #268
Merged
+70
−43
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
|
Checking if the read the docs build automatically does the |
559cf98 to
46c55f3
Compare
1ecf5ae to
45c1474
Compare
45c1474 to
866df24
Compare
jordandsullivan
approved these changes
Feb 27, 2025
| @@ -40,3 +40,7 @@ jobs: | |||
|
|
|||
| - name: Run tests | |||
| run: poetry run pytest ucc --verbose | |||
|
|
|||
| - name: Run doctest | |||
| # Check that code examples in docs execute as expected, and treat warnings as errors | |||
docs/source/api.rst
Outdated
| @@ -8,7 +8,3 @@ This page details the publicly accessible functions available in ``ucc``. | |||
|
|
|||
| .. autoclass:: ucc.transpilers.ucc_defaults.UCCDefault1 | |||
There was a problem hiding this comment.
With this latest change, I think the API doc looks a little bare. Do we want to leave it to #246 and
to define these?
There was a problem hiding this comment.
Rephrasing to be sure I'm following -- suggesting to remove this section for now as there's not much detail, and then bring it back as part of #246 ?
If so, then yes, I agree that makes sense.
There was a problem hiding this comment.
Yep, that's my suggestion.
There was a problem hiding this comment.
Updated with the suggested changes and docs look good, so merging now.
866df24 to
fe3f2e2
Compare
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.
Addresses #261 by setting up the PassManager in the
UCCDefaultinitializer rather than on each run. The second commit updates the corresponding examples in the docs to reflect current module structure, converts the examples to Sphix doctest to ensure examples we can automate checking they run properly with new code changes, and adds a doctest check to the Test workflow to do that automation.