Skip to content

Commit

Permalink
Bump sphinxcontrib-spelling and minor improvements (#16675)
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
kaxil committed Jun 26, 2021
1 parent 70cee15 commit 3a57d9f
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 105 deletions.
4 changes: 2 additions & 2 deletions airflow/providers/amazon/aws/sensors/s3_prefix.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
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.
Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,9 @@ def _get_params(root_schema: dict, prefix: str = "", default_section: str = "")

# -- 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/
Expand Down
Loading

0 comments on commit 3a57d9f

Please sign in to comment.