Reorganize API docs (backport #22) #23
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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
Applies the same changes from Qiskit/qiskit-addon-obp#24. Refer to that for more explanation. Some notes: * Removes `qiskit_addon_mpf.rst`, since users don't actually import this module directly * Inlines the three functions and one class in `qiskit_addon_mpf.static`. This means that it is our only API file, since there is only one module! - I'm not 100% sure it makes sense to inline these interfaces. Feel free to push back. They all seemed small enough to be worth it, but you can disagree. (cherry picked from commit 0667163)
Pull Request Test Coverage Report for Build 11596163758Details
💛 - Coveralls |
Eric-Arellano
approved these changes
Oct 30, 2024
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.
Applies the same changes from Qiskit/qiskit-addon-obp#24. Refer to that for more explanation.
Some notes:
qiskit_addon_mpf.rst, since users don't actually import this module directlyqiskit_addon_mpf.static. This means that it is our only API file, since there is only one module!This is an automatic backport of pull request #22 done by [Mergify](https://mergify.com).