[airflow] branch main updated: Bump ``sphinxcontrib-spelling`` and minor improvements (#16675)

[ka...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kaxilnaik pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/main by this push:
     new 3a57d9f  Bump ``sphinxcontrib-spelling`` and minor improvements (#16675)
3a57d9f is described below

commit 3a57d9fc604f4478fd51e20287494d0d7a33f0e4
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.
---
 airflow/providers/amazon/aws/sensors/s3_prefix.py |   4 +-
 docs/conf.py                                      |   3 +
 docs/spelling_wordlist.txt                        | 102 ----------------------
 setup.py                                          |   2 +-
 4 files changed, 6 insertions(+), 105 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 af0e421..b667511 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -649,6 +649,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 7a04e22..ad2a718 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,24 +110,20 @@ Dockerise
 Docstring
 Docstrings
 Dont
-Driesprong
 Drivy
 Dsn
 Dynamodb
 EDITMSG
 ETag
 Eg
-Elad
 EmrAddSteps
 EmrCreateJobFlow
 Enum
 Env
 EnvVar
-Ephraim
 ExaConnection
 Exasol
 Failover
-Feng
 Fernet
 FileSensor
 Filebeat
@@ -151,14 +135,12 @@ Firehose
 Firestore
 Flink
 FluentD
-Fokko
 Formaturas
 Fundera
 GCS
 GH
 GSoD
 Gantt
-Gao
 Gcp
 Gentner
 GetPartitions
@@ -171,39 +153,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
@@ -216,19 +187,13 @@ Json
 Jupyter
 KYLIN
 Kalibrr
-Kalif
-Kamil
-Kaxil
-Kengo
 Kerberized
 Kerberos
 KerberosClient
-KevinYang
 KeyManagementServiceClient
 Keyfile
 Kibana
 Kinesis
-Koka
 Kombu
 Kube
 Kubernetes
@@ -247,7 +212,6 @@ Liveness
 Logstash
 Lowin
 Lyft
-Maheshwari
 Makefile
 Mapreduce
 Mariadb
@@ -265,7 +229,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,16 +344,10 @@ Terraform
 TextToSpeechClient
 Tez
 Thinknear
-Timmins
 ToC
-Tomasz
 Tooltip
-Tsai
 Tuneables
-Tzu
-Tzu-ping
 UA
-Uellendall
 Umask
 Un
 Undead
@@ -409,14 +357,12 @@ Unpickle
 Upsert
 Upsight
 Uptime
-Urbaszek
 Url
 Utils
 Vendorize
 Vertica
 Vevo
 VideoIntelligenceServiceClient
-Vikram
 VolumeMount
 WTF
 WaiterModel
@@ -425,20 +371,15 @@ WebClient
 Webhook
 Webserver
 Werkzeug
-Wiedmer
 XCom
 XComs
 Xcom
 Xero
-Xiaodong
-Xinbin
 Yamllint
 Yandex
 Yieldr
-Yu
 Zego
 Zendesk
-Zhong
 Zsh
 Zymergen
 abc
@@ -449,14 +390,11 @@ acknowledgement
 actionCard
 acyclic
 adhoc
-aijamalnk
 airbnb
 airbyte
-airfl
 airflowignore
 ajax
 alertPolicies
-alexvanboxel
 allAuthenticatedUsers
 allUsers
 allowinsert
@@ -467,7 +405,6 @@ analyticsreporting
 analyzeEntities
 analyzeSentiment
 analyzeSyntax
-aoen
 apache
 api
 apikey
@@ -478,13 +415,11 @@ arg
 args
 arn
 arraysize
-artwr
 asana
 asc
 ascii
 asciiart
 asctime
-ashb
 asia
 assertEqualIgnoreMultipleSpaces
 ast
@@ -531,7 +466,6 @@ baseOperator
 basestring
 basetaskrunner
 bashrc
-basph
 batchGet
 bc
 bcc
@@ -541,7 +475,6 @@ behaviours
 bigquery
 bigtable
 bitshift
-bolkedebruin
 booktabs
 bool
 boolean
@@ -630,7 +563,6 @@ crd
 createDisposition
 creationTimestamp
 credssp
-criccomini
 cron
 cronjob
 crontab
@@ -701,7 +633,6 @@ dev
 devel
 df
 dicts
-dimberman
 dimensionX
 dingding
 dir
@@ -729,7 +660,6 @@ dropdown
 druidHook
 ds
 dsn
-dstandish
 dttm
 dtypes
 durations
@@ -741,7 +671,6 @@ ec
 ecb
 editorconfig
 eg
-eladkal
 elasticsearch
 emr
 enableAutoScale
@@ -756,7 +685,6 @@ envFrom
 envvar
 eol
 eols
-ephraimbuddy
 errno
 eslint
 etl
@@ -780,7 +708,6 @@ faq
 fbee
 fc
 feedCard
-feluelle
 feng
 fernet
 fetchmany
@@ -799,7 +726,6 @@ fluentd
 fmt
 fn
 fo
-fokko
 followsa
 formatter
 fot
@@ -851,7 +777,6 @@ hdfscli
 hdp
 healthjump
 heartrate
-hiteshs
 hivecmd
 hiveconf
 hiveconfs
@@ -864,7 +789,6 @@ hostPath
 hostname
 hostnames
 hotfix
-houqp
 howto
 hql
 html
@@ -925,29 +849,21 @@ javascript
 jaydebeapi
 jdbc
 jdk
-jedcunningham
 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
@@ -969,14 +885,11 @@ kv
 kwarg
 kwargs
 kylin
-kyzy
-laj
 lastname
 latencies
 latin
 ldap
 ldaps
-leahecole
 leveldb
 libs
 libz
@@ -1018,12 +931,10 @@ mget
 microservice
 microsoft
 middleware
-mik
 milton
 minicluster
 minikube
 misconfigured
-mistercrunch
 mixup
 mkdir
 mkdirs
@@ -1038,7 +949,6 @@ moto
 mouseover
 msg
 mssql
-msumit
 mutex
 mv
 mypy
@@ -1131,7 +1041,6 @@ pooler
 postMessage
 postfix
 postgres
-potiuk
 powershell
 pql
 pre
@@ -1233,10 +1142,7 @@ ru
 runAsUser
 runnable
 runtime
-ryanahamilton
-ryw
 sagemaker
-saguziel
 salesforce
 samesite
 sanitization
@@ -1259,7 +1165,6 @@ securityManager
 seealso
 seedlist
 segmentGranularity
-sekikn
 sendgrid
 serialise
 serializable
@@ -1362,7 +1267,6 @@ tableauserverclient
 tablefmt
 tagKey
 tagValue
-tao
 task_group
 taskflow
 taskinstance
@@ -1402,7 +1306,6 @@ trino
 trojan
 tsv
 ttl
-turbaszek
 txt
 tz
 tzinfo
@@ -1427,7 +1330,6 @@ updateMask
 updateonly
 upsert
 upserts
-uranusjr
 uri
 uris
 url
@@ -1455,7 +1357,6 @@ versionable
 vertica
 verticaql
 videointelligence
-vikramkoka
 virtualenv
 vm
 volumeMounts
@@ -1481,7 +1382,6 @@ www
 xcom
 xcomarg
 xcomresult
-xinbinhuang
 xml
 xpath
 xyz
@@ -1492,9 +1392,7 @@ yarnpkg
 yml
 youtrack
 youtube
-yuqian
 zA
 zendesk
-zhongjiajie
 zope
 zsh
diff --git a/setup.py b/setup.py
index d9236fa..6d04259 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',