Skip to content

Apply spell check to tutorials #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 28 commits into from
May 21, 2021
Merged

Apply spell check to tutorials #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
ab68d80
apply spell check to tutorials
t-imamichi Mar 31, 2021
20362fe
add a package
t-imamichi Mar 31, 2021
14ec6b8
treat spelling warning as error
t-imamichi Mar 31, 2021
26d7788
Merge branch 'master' into spellcheck-tutorials
manoelmarques Apr 1, 2021
6067048
add pylintdict as word list of tutorial check
t-imamichi Apr 1, 2021
bbae72c
update spelling word list
t-imamichi Apr 1, 2021
9e4f9c7
add a word
t-imamichi Apr 1, 2021
a1a022a
change var_form to ansatz
t-imamichi Apr 1, 2021
e962302
simplify
t-imamichi Apr 1, 2021
fef004e
rename all var_form to ansatz
t-imamichi Apr 1, 2021
3281675
Merge branch 'master' into spellcheck-tutorials
t-imamichi Apr 1, 2021
32d1f71
Merge branch 'master' into spellcheck-tutorials
t-imamichi Apr 2, 2021
60d3973
Merge branch 'master' into spellcheck-tutorials
manoelmarques Apr 2, 2021
53f61f3
Merge branch 'master' into spellcheck-tutorials
manoelmarques Apr 4, 2021
9010c28
add a word
t-imamichi Apr 5, 2021
a418d08
Merge branch 'master' into spellcheck-tutorials
manoelmarques Apr 12, 2021
d020e9e
Merge branch 'master' into spellcheck-tutorials
manoelmarques Apr 15, 2021
d12bee9
Merge branch 'main' into spellcheck-tutorials
manoelmarques Apr 21, 2021
8ab8069
Merge branch 'main' into spellcheck-tutorials
t-imamichi Apr 22, 2021
123591e
Merge branch 'main' into spellcheck-tutorials
t-imamichi Apr 24, 2021
3eb8517
Merge branch 'main' into spellcheck-tutorials
manoelmarques Apr 26, 2021
81c6e56
Merge branch 'main' into spellcheck-tutorials
manoelmarques Apr 27, 2021
bfe4858
Merge branch 'main' into spellcheck-tutorials
t-imamichi May 6, 2021
f4f7b44
Merge branch 'main' into spellcheck-tutorials
manoelmarques May 17, 2021
1f9f50e
Merge branch 'main' into spellcheck-tutorials
t-imamichi May 18, 2021
71086e1
add words
t-imamichi May 18, 2021
f0b5fa7
Merge branch 'main' into spellcheck-tutorials
manoelmarques May 20, 2021
70e7498
fix doc spelling
manoelmarques May 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ test_ci:

spell:
pylint -rn --disable=all --enable=spelling --spelling-dict=en_US --spelling-private-dict-file=.pylintdict qiskit_optimization test tools
make -C docs spell SPHINXOPTS=$(SPHINXOPTS)

copyright:
python tools/check_copyright.py
Expand Down
3 changes: 3 additions & 0 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ BUILDDIR = _build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

spell:
@$(SPHINXBUILD) -W -b spelling "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@
'_static/5_ADMM.png',
}

spelling_word_list_filename = ['spelling_wordlist.txt', '../.pylintdict']

# -----------------------------------------------------------------------------
# Autosummary
# -----------------------------------------------------------------------------
Expand Down
92 changes: 92 additions & 0 deletions docs/spelling_wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
ADMMOptimizationResult
ADMMOptimizer
ADMMParameters
ADMMState
Aer
Applegate
BaseAggregator
Bixby
CVaR
Chvátal
CobylaOptimizer
CplexOptimizer
ExactCover
Farhi
GoemansWilliamsonOptimizationResult
GoemansWilliamsonOptimizer
Goldstone
GraphOptimizationApplication
GraphPartition
GroverOptimizationResult
GroverOptimizer
Gutmann
InequalityToEquality
IntegerToBinary
IntermediateResult
LinearConstraint
LinearEqualityToPenalty
LinearExpression
macOS
MeanAggregator
MinimumEigenOptimizationResult
MinimumEigenOptimizer
MultiStartOptimizer
Neven
NetworkX
NumberPartition
Optimality
OptimizationAlgorithm
OptimizationApplication
OptimizationResult
OptimizationResultStatus
QiskitOptimizationError
QuadraticConstraint
QuadraticExpression
QuadraticObjective
QuadraticProgram
QuadraticProgramConverter
QuadraticProgramElement
QuadraticProgramToQubo
RecursiveMinimumEigenOptimizationResult
RecursiveMinimumEigenOptimizer
Rz
SetPacking
SlsqpOptimizationResult
SlsqpOptimizer
SolutionSample
StableSet
Travelling
Troyer
VehicleRouting
VertexCover
WarmStartQAOAFactory
WarmStartQAOAOptimizer
Wecker
Zemlin
adaptively
arXiv
arxiv
behaviour
combinatorial
deterministically
doi
dok
entangler
exponentiated
fmin
multiset
optimality
param
probabilistically
rtype
slsqp
smoothen
subcollection
subproblem
summands
traceback
tradeoff
tsplib
undirected
wavefunction
zsh
1 change: 1 addition & 0 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Sphinx>=1.8.3,!=3.1.0,<4
sphinx-panels
sphinx-gallery
sphinx-autodoc-typehints
sphinxcontrib-spelling
jupyter-sphinx
discover
qiskit-aer
Expand Down