Reorganize transpiler modules in API docs #1645
Merged
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
Eric-Arellano
requested review from
jyu00,
taalexander and
kt474
and removed request for
jyu00
kt474
approved these changes
Apr 30, 2024
Pull Request Test Coverage Report for Build 8902057614Details
💛 - Coveralls |
Eric-Arellano
added a commit
to Eric-Arellano/qiskit-ibm-runtime
that referenced
this pull request
May 1, 2024
Closes Qiskit/documentation#1240 and partially addresses Qiskit/documentation#942 for runtime. ## Reduces `transpiler` modules Before: | module | status | | --- | --- | | qiskit.transpiler | only links to `passes` | | qiskit.transpiler.passes | only links to `basis` and `scheduling` | | qiskit.transpiler.passes.basis | empty, should link to ConvertIdToDelay but doesn't | | qiskit.transpiler.passes.scheduling | useful | Now: | module | status | | --- | --- | | qiskit.transpiler.passes | links to `ConvertIdToDelay` and `scheduling` | | qiskit.transpiler.passes.scheduling | useful | This saves the user clicks. Now each page is useful enough to stand on its own. This is what the index page now looks like: <img width="689" alt="Screenshot 2024-04-30 at 4 20 41 PM" src="https://github.com/Qiskit/qiskit-ibm-runtime/assets/14852634/8cdefee6-b8a7-491d-be32-aeb974fce92b"> This change assumes that we will not add new modules to `qiskit.transpiler` for some time, such as `qiskit.transpiler.my_module`. If we do eventually add a new module, then we can easily revert `transpiler.rst` to point to `qiskit_ibm_runtime.transpiler` again. This change also assumes that we won't lots of new APIs to `qiskit.transpiler.passes.basis`. If we do, we would want to consider going back to `qiskit.transpiler.passes.basis` being its own standalone page. We can do that easily if necessary in the future. ## Improves header hierarchy ### Options Before, we were using bold text to act like headers. Instead, we should be using proper headers for styling, SEO, and accessibility (screen readers). ### `qiskit_ibm_runtime.transpiler.passes.scheduling` This PR moves the `classes` list to be higher in the file and fixes some of the other headers to higher heading levels. ## Removes unused docstrings The `utils` module is not exposed, and Kevin said it should not be since it's internal. So I deleted its docstring to make this more clear.
kt474
pushed a commit
that referenced
this pull request
May 1, 2024
Closes Qiskit/documentation#1240 and partially addresses Qiskit/documentation#942 for runtime. ## Reduces `transpiler` modules Before: | module | status | | --- | --- | | qiskit.transpiler | only links to `passes` | | qiskit.transpiler.passes | only links to `basis` and `scheduling` | | qiskit.transpiler.passes.basis | empty, should link to ConvertIdToDelay but doesn't | | qiskit.transpiler.passes.scheduling | useful | Now: | module | status | | --- | --- | | qiskit.transpiler.passes | links to `ConvertIdToDelay` and `scheduling` | | qiskit.transpiler.passes.scheduling | useful | This saves the user clicks. Now each page is useful enough to stand on its own. This is what the index page now looks like: <img width="689" alt="Screenshot 2024-04-30 at 4 20 41 PM" src="https://github.com/Qiskit/qiskit-ibm-runtime/assets/14852634/8cdefee6-b8a7-491d-be32-aeb974fce92b"> This change assumes that we will not add new modules to `qiskit.transpiler` for some time, such as `qiskit.transpiler.my_module`. If we do eventually add a new module, then we can easily revert `transpiler.rst` to point to `qiskit_ibm_runtime.transpiler` again. This change also assumes that we won't lots of new APIs to `qiskit.transpiler.passes.basis`. If we do, we would want to consider going back to `qiskit.transpiler.passes.basis` being its own standalone page. We can do that easily if necessary in the future. ## Improves header hierarchy ### Options Before, we were using bold text to act like headers. Instead, we should be using proper headers for styling, SEO, and accessibility (screen readers). ### `qiskit_ibm_runtime.transpiler.passes.scheduling` This PR moves the `classes` list to be higher in the file and fixes some of the other headers to higher heading levels. ## Removes unused docstrings The `utils` module is not exposed, and Kevin said it should not be since it's internal. So I deleted its docstring to make this more clear.
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.
Closes Qiskit/documentation#1240 and partially addresses Qiskit/documentation#942 for runtime.
Reduces
transpilermodulesBefore:
passesbasisandschedulingNow:
ConvertIdToDelayandschedulingThis saves the user clicks. Now each page is useful enough to stand on its own.
This is what the index page now looks like:
This change assumes that we will not add new modules to
qiskit.transpilerfor some time, such asqiskit.transpiler.my_module. If we do eventually add a new module, then we can easily reverttranspiler.rstto point toqiskit_ibm_runtime.transpileragain.This change also assumes that we won't lots of new APIs to
qiskit.transpiler.passes.basis. If we do, we would want to consider going back toqiskit.transpiler.passes.basisbeing its own standalone page. We can do that easily if necessary in the future.Improves header hierarchy
Options
Before, we were using bold text to act like headers. Instead, we should be using proper headers for styling, SEO, and accessibility (screen readers).
qiskit_ibm_runtime.transpiler.passes.schedulingThis PR moves the
classeslist to be higher in the file and fixes some of the other headers to higher heading levels.Removes unused docstrings
The
utilsmodule is not exposed, and Kevin said it should not be since it's internal. So I deleted its docstring to make this more clear.