You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ka...@apache.org on 2021/08/17 23:01:53 UTC
[airflow] 03/03: Bump ``sphinxcontrib-spelling`` and minor
improvements (#16675)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch v2-1-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 5f9930bd3df4119b19baedd2722b4e9c3359b08e
Author: Kaxil Naik <ka...@gmail.com>
AuthorDate: Sat Jun 26 18:33:22 2021 +0100
Bump ``sphinxcontrib-spelling`` and minor improvements (#16675)
- Bump `sphinxcontrib-spelling` from `5.2.1` to `7.2.1`
- Excludes `project.rst` and `changelog.rst` from spell-check for `apache-airflow` package so that we don't need to add Committer's Name everytime.
- Removes committers name and ``'airfl%'`` from `docs/spelling_wordlist.txt` as it isn't needed. It should be a code-block not an actual word.
(cherry picked from commit 3a57d9fc604f4478fd51e20287494d0d7a33f0e4)
---
airflow/providers/amazon/aws/sensors/s3_prefix.py | 4 +-
docs/conf.py | 3 +
docs/spelling_wordlist.txt | 99 -----------------------
setup.py | 2 +-
4 files changed, 6 insertions(+), 102 deletions(-)
diff --git a/airflow/providers/amazon/aws/sensors/s3_prefix.py b/airflow/providers/amazon/aws/sensors/s3_prefix.py
index 2fa923a..54270ac 100644
--- a/airflow/providers/amazon/aws/sensors/s3_prefix.py
+++ b/airflow/providers/amazon/aws/sensors/s3_prefix.py
@@ -24,8 +24,8 @@ from airflow.sensors.base import BaseSensorOperator
class S3PrefixSensor(BaseSensorOperator):
"""
Waits for a prefix to exist. A prefix is the first part of a key,
- thus enabling checking of constructs similar to glob airfl* or
- SQL LIKE 'airfl%'. There is the possibility to precise a delimiter to
+ thus enabling checking of constructs similar to glob ``airfl*`` or
+ SQL LIKE ``'airfl%'``. There is the possibility to precise a delimiter to
indicate the hierarchy or keys, meaning that the match will stop at that
delimiter. Current code accepts sane delimiters, i.e. characters that
are NOT special characters in the Python regex engine.
diff --git a/docs/conf.py b/docs/conf.py
index da3b8e2..fb5a884 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -633,6 +633,9 @@ redirects_file = 'redirects.txt'
# -- Options for sphinxcontrib-spelling ----------------------------------------
spelling_word_list_filename = [os.path.join(CONF_DIR, 'spelling_wordlist.txt')]
+if PACKAGE_NAME == 'apache-airflow':
+ spelling_exclude_patterns = ['project.rst', 'changelog.rst']
+spelling_ignore_contributor_names = False
# -- Options for sphinxcontrib.redoc -------------------------------------------
# See: https://sphinxcontrib-redoc.readthedocs.io/en/stable/
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index 4b071a8..0ad4070 100644
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -4,14 +4,11 @@ AgentKey
Airbnb
Airbyte
AirflowException
-Aizhamal
Alphasort
Analytics
AnalyzeEntitiesResponse
AnalyzeSentimentResponse
AnalyzeSyntaxResponse
-Anand
-Anierobi
AnnotateTextResponse
Ansible
AppBuilder
@@ -32,7 +29,6 @@ Backfill
BackfillJobTest
Backfills
Banco
-Bas
BaseClient
BaseOperator
BaseView
@@ -42,14 +38,11 @@ Bigquery
Bigtable
Bitshift
Bluecore
-Bolke
Bool
Booleans
Boto
BounceX
-Boxel
Bq
-BreguĊa
CSRFProtect
Cancelled
Cassanda
@@ -57,11 +50,9 @@ Catchup
Celect
Cgroups
Changelog
-Chao
CheckOperator
Checklicence
Checkr
-Chung
Cinimex
ClassifyTextResponse
CloudTasksClient
@@ -78,7 +69,6 @@ Configs
ContainerPort
Cron
Ctrl
-Cunningham
DBs
Daemonize
DagFileProcessorManager
@@ -103,8 +93,6 @@ Datasync
DateFrame
Datetimepicker
Datetimes
-Davydov
-De
Decrypt
Decrypts
DeidentifyContentResponse
@@ -122,7 +110,6 @@ Dockerise
Docstring
Docstrings
Dont
-Driesprong
Drillbit
Drivy
Dsn
@@ -130,17 +117,14 @@ Dynamodb
EDITMSG
ETag
Eg
-Elad
EmrAddSteps
EmrCreateJobFlow
Enum
Env
EnvVar
-Ephraim
ExaConnection
Exasol
Failover
-Feng
Fernet
FileSensor
Filebeat
@@ -152,14 +136,12 @@ Firehose
Firestore
Flink
FluentD
-Fokko
Formaturas
Fundera
GCS
GH
GSoD
Gantt
-Gao
Gcp
Gentner
GetPartitions
@@ -172,39 +154,28 @@ Groupalia
Groupon
Grpc
Gunicorn
-Guziel
Gzip
HCatalog
HTTPBasicAuth
-Harenslak
Hashable
Hashicorp
Highcharts
-Hitesh
Hiveserver
Hoc
-Homan
HostAliases
Hostname
-Hou
Http
HttpError
HttpRequest
-Huang
IdP
ImageAnnotatorClient
Imap
-Imberman
InsecureClient
InspectContentResponse
InspectTemplate
Investorise
JPype
-Jakob
-Jarek
Jdbc
-Jed
-Jiajie
Jinja
Jinjafied
Jinjafy
@@ -217,19 +188,13 @@ Json
Jupyter
KYLIN
Kalibrr
-Kalif
-Kamil
-Kaxil
-Kengo
Kerberized
Kerberos
KerberosClient
-KevinYang
KeyManagementServiceClient
Keyfile
Kibana
Kinesis
-Koka
Kombu
Kube
Kubernetes
@@ -248,7 +213,6 @@ Liveness
Logstash
Lowin
Lyft
-Maheshwari
Makefile
Mapreduce
Mariadb
@@ -266,7 +230,6 @@ Multinamespace
Mysql
NFS
NaN
-Naik
Namenode
Namespace
Neo4j
@@ -274,7 +237,6 @@ Nextdoor
Nones
NotFound
Nullable
-Nurmamat
OAuth
Oauth
Oauthlib
@@ -298,7 +260,6 @@ Pinot
Popen
Postgres
Postgresql
-Potiuk
Pre
Precommit
PredictionServiceClient
@@ -314,8 +275,6 @@ Pyarrow
Pylint
Pyspark
PythonOperator
-Qian
-Qingping
Qplum
Quantopian
Qubole
@@ -331,7 +290,6 @@ Redhat
ReidentifyContentResponse
Reinitialising
ResourceRequirements
-Riccomini
Roadmap
Robinhood
SIGTERM
@@ -342,9 +300,7 @@ Sagemaker
Sasl
SecretManagerClient
Seedlist
-Seki
Sendgrid
-Siddharth
SlackHook
Spark
SparkPi
@@ -358,7 +314,6 @@ Sqlite
Sqoop
Stackdriver
Standarization
-Standish
StatefulSet
StatefulSets
StatsD
@@ -373,7 +328,6 @@ Subpackages
Subpath
SubscriberClient
Subtasks
-Sumit
Systemd
TCP
TLS
@@ -390,15 +344,10 @@ Terraform
TextToSpeechClient
Tez
Thinknear
-Timmins
ToC
-Tomasz
Tooltip
-Tsai
Tuneables
-Tzu-ping
UA
-Uellendall
Umask
Un
Undead
@@ -408,14 +357,12 @@ Unpickle
Upsert
Upsight
Uptime
-Urbaszek
Url
Utils
Vendorize
Vertica
Vevo
VideoIntelligenceServiceClient
-Vikram
VolumeMount
WTF
WaiterModel
@@ -424,20 +371,15 @@ WebClient
Webhook
Webserver
Werkzeug
-Wiedmer
XCom
XComs
Xcom
Xero
-Xiaodong
-Xinbin
Yamllint
Yandex
Yieldr
-Yu
Zego
Zendesk
-Zhong
Zsh
Zymergen
abc
@@ -448,14 +390,11 @@ acknowledgement
actionCard
acyclic
adhoc
-aijamalnk
airbnb
airbyte
-airfl
airflowignore
ajax
alertPolicies
-alexvanboxel
allAuthenticatedUsers
allUsers
allowinsert
@@ -466,7 +405,6 @@ analyticsreporting
analyzeEntities
analyzeSentiment
analyzeSyntax
-aoen
apache
api
apikey
@@ -477,13 +415,11 @@ arg
args
arn
arraysize
-artwr
asana
asc
ascii
asciiart
asctime
-ashb
asia
assertEqualIgnoreMultipleSpaces
ast
@@ -530,7 +466,6 @@ baseOperator
basestring
basetaskrunner
bashrc
-basph
batchGet
bc
bcc
@@ -540,7 +475,6 @@ behaviours
bigquery
bigtable
bitshift
-bolkedebruin
booktabs
boolean
booleans
@@ -627,7 +561,6 @@ crd
createDisposition
creationTimestamp
credssp
-criccomini
cron
cronjob
crontab
@@ -698,7 +631,6 @@ dev
devel
df
dicts
-dimberman
dimensionX
dingding
dir
@@ -725,7 +657,6 @@ dropdown
druidHook
ds
dsn
-dstandish
dttm
dtypes
durations
@@ -737,7 +668,6 @@ ec
ecb
editorconfig
eg
-eladkal
elasticsearch
emr
enableAutoScale
@@ -751,7 +681,6 @@ env
envFrom
envvar
eols
-ephraimbuddy
errno
eslint
etl
@@ -775,7 +704,6 @@ faq
fbee
fc
feedCard
-feluelle
feng
fernet
fetchmany
@@ -794,7 +722,6 @@ fluentd
fmt
fn
fo
-fokko
followsa
formatter
fot
@@ -846,7 +773,6 @@ hdfscli
hdp
healthjump
heartrate
-hiteshs
hivecmd
hiveconf
hiveconfs
@@ -859,7 +785,6 @@ hostPath
hostname
hostnames
hotfix
-houqp
howto
hql
html
@@ -919,27 +844,20 @@ jaydebeapi
jdbc
jdk
jenkins
-jghoman
-jhtimmins
jinja
jira
jitter
-jlowin
-jmcarp
jobId
jobName
jobflow
jobtracker
jos
journald
-joygao
js
json
jthomas
jupyter
jupytercmd
-kaxil
-kaxilnaik
keepalive
keepalives
kerberized
@@ -960,14 +878,11 @@ kv
kwarg
kwargs
kylin
-kyzy
-laj
lastname
latencies
latin
ldap
ldaps
-leahecole
leveldb
libs
libz
@@ -1008,12 +923,10 @@ mget
microservice
microsoft
middleware
-mik
milton
minicluster
minikube
misconfigured
-mistercrunch
mixup
mkdir
mkdirs
@@ -1028,7 +941,6 @@ moto
mouseover
msg
mssql
-msumit
mutex
mv
mypy
@@ -1121,7 +1033,6 @@ pooler
postMessage
postfix
postgres
-potiuk
powershell
pql
pre
@@ -1223,10 +1134,7 @@ ru
runAsUser
runnable
runtime
-ryanahamilton
-ryw
sagemaker
-saguziel
salesforce
samesite
sanitization
@@ -1249,7 +1157,6 @@ securityManager
seealso
seedlist
segmentGranularity
-sekikn
sendgrid
serialise
serializable
@@ -1352,7 +1259,6 @@ tableauserverclient
tablefmt
tagKey
tagValue
-tao
task_group
taskflow
taskinstance
@@ -1392,7 +1298,6 @@ trino
trojan
tsv
ttl
-turbaszek
txt
tz
tzinfo
@@ -1444,7 +1349,6 @@ versionable
vertica
verticaql
videointelligence
-vikramkoka
virtualenv
vm
volumeMounts
@@ -1470,7 +1374,6 @@ www
xcom
xcomarg
xcomresult
-xinbinhuang
xml
xpath
xyz
@@ -1481,9 +1384,7 @@ yarnpkg
yml
youtrack
youtube
-yuqian
zA
zendesk
-zhongjiajie
zope
zsh
diff --git a/setup.py b/setup.py
index 2027b61..daf1839 100644
--- a/setup.py
+++ b/setup.py
@@ -250,7 +250,7 @@ doc = [
'sphinx-rtd-theme>=0.1.6',
'sphinxcontrib-httpdomain>=1.7.0',
'sphinxcontrib-redoc>=1.6.0',
- 'sphinxcontrib-spelling==5.2.1',
+ 'sphinxcontrib-spelling==7.2.1',
]
docker = [
'docker',