Documentation adjustments #5
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
mrossinek
commented
Sep 11, 2024
Comment on lines
+82
to
+88
| [tool.coverage.run] | ||
| branch = true | ||
| parallel = true | ||
|
|
||
| [tool.coverage.report] | ||
| fail_under = 100 | ||
| show_missing = true |
There was a problem hiding this comment.
This may need to be amended. See also next comment
mrossinek
commented
Sep 11, 2024
README.md
Outdated
| [](LICENSE.txt) | ||
| [](https://pypi.org/project/qiskit-addon-sqd/) | ||
| [](https://github.com/Qiskit/qiskit-addon-sqd/actions/workflows/test_latest_versions.yml) | ||
| [](https://coveralls.io/github/Qiskit/qiskit-addon-sqd?branch=main) |
There was a problem hiding this comment.
Might need to hold off on this one until 0.4 when I have full set of tests + bug fixes
There was a problem hiding this comment.
Have removed this coverage shield for now until I get the source code tested to standards
caleb-johnson
changed the title
qiskit-addon-utils repo| pylint -rn qiskit_addon_sqd/ test/ | ||
| nbqa pylint -rn docs/ | ||
| pydocstyle qiskit_addon_sqd/ | ||
| reno lint |
There was a problem hiding this comment.
I went ahead and removed typos from the linter. It found one typo and one false positive. I fixed those, and it is now failing in CI and giving no indication why (I can't reproduce locally)
I feel fairly strongly that typos gets in the way more than it helps (Ive had trouble getting dictionaries to be read and trouble getting CI to tell me what happened with typos). Unless you feel strongly about this, I may leave it out of the linter
There was a problem hiding this comment.
It surprises me, that typos caused this trouble. Here are some notes:
typosappears to never have been declared as a dependency (smth I overlooked as well) which makes me wonder why trying to execute the command gave an exit code2rather than127, but could be the reason why it kept failing at the endtyposdoes NOT use a dictionary by design. Instead, it keeps an internal list of common typos which it detects and marks. This cuts down a LOT on false positives compared to e.g. pylint's spell checker. See here for more details.
mergify bot
pushed a commit
that referenced
this pull request
Sep 11, 2024
* Some fixes and alignments with the `qiskit-addon-utils` repo * style * Ignore slow notebooks, fix bad import * ruff * Add typos to externals and fix a typo * Fix typos * Remove typos * Remove typos * implement feedback * rename dice solver how-to * Fix references in tutorial 1 --------- Co-authored-by: Caleb Johnson <[email protected]> (cherry picked from commit b86b32c)
caleb-johnson
pushed a commit
that referenced
this pull request
Sep 11, 2024
* Some fixes and alignments with the `qiskit-addon-utils` repo * style * Ignore slow notebooks, fix bad import * ruff * Add typos to externals and fix a typo * Fix typos * Remove typos * Remove typos * implement feedback * rename dice solver how-to * Fix references in tutorial 1 --------- Co-authored-by: Caleb Johnson <[email protected]> (cherry picked from commit b86b32c) Co-authored-by: Max Rossmannek <[email protected]>
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.
This PR implements mostly documentation and CI adjustments which bring the package more in-line with other Qiskit addons.