Closed woodsp-ibm closed 4 months ago
It failed spell checking on bits of a url
pylint -rn --disable=all --enable=spelling --spelling-dict=en_US --spelling-private-dict-file=.pylintdict qiskit_optimization test tools
************* Module qiskit_optimization
qiskit_optimization/__init__.py:21:0: C0402: Wrong spelling of a word 'github' in a docstring:
fundamental `minimum eigensolvers <https://qiskit-community.github.io/qiskit-algorithms/apidocs/
^^^^^^
Did you mean: ''git hub' or 'git-hub' or 'GitHub''? (wrong-spelling-in-docstring)
qiskit_optimization/__init__.py:21:0: C0402: Wrong spelling of a word 'io' in a docstring:
fundamental `minimum eigensolvers <https://qiskit-community.github.io/qiskit-algorithms/apidocs/
^^
Did you mean: ''oi' or 'Io' or 'oo' or 'ii''? (wrong-spelling-in-docstring)
which seemed weird as other urls there passed ok that also had github.io in them, and were even there ahead of this recent change. The only difference I could see was that other urls were not split over two lines so I altered the format to have it on one line. Its long but still passes lint and black locally for me, so hopefully that sorted things as otherwise I'd have to add the bits to the custom spell dict that I would prefer to avoid doing in this case.
Update: That fixed it - i.e avoided the url being spell checked!
Totals | |
---|---|
Change from base Build 7793734126: | 0.0% |
Covered Lines: | 4511 |
Relevant Lines: | 4849 |
Summary
Updates links away from qiskit.org to the new locations for the docs
Fixes #585 Fixes #586
Details and comments
Now that all the applications and the algorithms docs are deployed on github pages this updates the intersphinx links, in conf.py, and also urls that are coded directly in other places such as the readme and tutorials. I did not alter past release notes. There is a redirect now in effect for the former location on
qiskit.org/ecosystem
so they get to the right place.Note that the current theme is still emitting a link to qiskit.org/ecosystem, but that will get redirected for now until such time as Qiskit/qiskit_sphinx_theme#588 is resolved and new docs are generated with such an updated theme and re-deployed.