question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add Sphinx Spell-Checker

See original GitHub issue

We have been fixing various typos in the project but it would be good if we can enable a Spell Checker for our Docsite. So our docs are typo-free.

We can use https://pypi.org/project/sphinxcontrib-spelling/ to do this. Docs: https://sphinxcontrib-spelling.readthedocs.io/en/latest/

I gave it a shot but unfortunately, there are too many words that we need to add in docs/spelling_wordlist.txt.

Here is the list I had but there are still ~6k more words that need to be added, if someone wants to give it a shot:

Acyclic
Airbnb
Async
Avro
Bas
BaseView
Cassanda
DagRun
Dask
Dataproc
Datastore
Gantt
Gunicorn
Harenslak
Hashicorp
Jarek
Jinja
Jira
Kamil
Kerberos
Kibana
Kubernetes
Oozie
Opsgenie
Parameterizing
Potiuk
Py
Qubole
Sqoop
Standarization
Systemd
Templating
XCom
XComs
Zsh
adls
airflow
airflowignore
ansible
apikey
argcomplete
args
async
auth
autocommit
autodetect
automl
autoscale
aws
backend
backfill
backfilled
bashcompinit
batcher
bigquery
bigtable
bitshift
boto
botocore
catchup
cfg
chown
classmethod
cloudant
cloudsql
cncf
config
configMapRef
configmap
configuing
cronjob
crypto
cyexamplekey
dag
dagbag
dagruns
databricks
datadog
dataset
datasets
datetime
dbs
dejson
deserializing
dest
dev
devel
dingding
distros
dockerenv
docstring
docstrings
elasticsearch
envFrom
eventlet
exampleinclude
exasol
facebook
failover
fernet
fluentd
fs
gRPC
gcp
gcpcloudsql
gevent
github
greenlets
grpc
gssapi
hadoop
hashicorp
hdfs
hiveserver
howto
httpbin
imap
initdb
integration
integrations
jalr
jdbc
jinja
keytab
krb
kubernetes
kwargs
kylin
licence
literalinclude
logins
loglevel
logstash
lshift
macOS
mdeng
memorystore
mesos
metadatabase
metarouter
metastore
mongo
msg
mssql
noqa
odbc
papermill
param
paramiko
petabyte
pgdatabase
pghost
pgpassfile
pgpassword
pgport
pguser
pidfile
pinot
postgre
postgres
postgresql
precheck
proc
programmatically
psql
py
pylint
pythonpath
rankdir
rbac
readthedocs
resetdb
rshift
rst
salesforce
saml
sanitization
searchpath
secretRef
secretsmanager
seealso
serverless
sftp
smtps
spegno
sqla
stackdriver
statsd
stdout
subcommand
subdag
subgraph
subpackage
subpackages
subprocesses
sudo
tablename
templated
templating
teradata
timedelta
umask
unpause
upgradedb
upsert
uptime
utcnow
versionable
vertica
wasb
webhdfs
webserver
xcom
xxxxxxxx
yandex
yandexcloud

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:3
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
caddaccommented, Aug 10, 2020

I’d like to work on this issue. Hoping to have a PR in the next day or so.

0reactions
kaxilcommented, Aug 11, 2020
  1. Should we have a specific command to run spell check other than building the docs? in breeze too?

I took a look at your PR and I think running the spell check as part of the doc only makes sense for now. We don’t need a separate command for it. Even if we would want to do it, it can happen in a separate PR 😃

  1. Should I my PR to update the spellings for as many of the misspellings as I can? It will boost the number of files I change, obviously.

Yes, otherwise the PR would fail so atleast I would expect it to fail.

Read more comments on GitHub >

github_iconTop Results From Across the Web

sphinxcontrib.spelling — sphinxcontrib.spelling 1.4 ...
sphinxcontrib.spelling is a spelling checker for Sphinx. It uses PyEnchant to produce a report showing misspelled words. Features ...
Read more >
A spelling checker for Sphinx-based documentation - GitHub
This package contains sphinxcontrib.spelling, a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled ...
Read more >
sphinxcontrib-spelling - PyPI
This package contains sphinxcontrib.spelling, a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled ...
Read more >
Creating a Spelling Checker for reStructuredText Documents
To add a step to the build to check the spelling of every file, I would need two new tools: an extension to...
Read more >
Sphinxcontrib Spelling - :: Anaconda.org
This package contains sphinxcontrb.spelling, a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found