Skip to content

Commit

Permalink
Add spell config
Browse files Browse the repository at this point in the history
  • Loading branch information
Erotemic committed Oct 17, 2024
1 parent e7f93d4 commit b8ca5ed
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
4 changes: 2 additions & 2 deletions dev/maintain/gen_api_for_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -242,11 +242,11 @@ def gen_api_for_docs(modname):
# For README
python ~/code/ubelt/dev/maintain/gen_api_for_docs.py --url-mode
python ~/code/ubelt/dev/maintain/gen_api_for_docs.py --extra_modname=bioharn,watch --remove_zeros=False --url-mode
python ~/code/ubelt/dev/maintain/gen_api_for_docs.py --extra_modnames=bioharn,geowatch --remove_zeros=False --url-mode
# First run and copy the table:
python ~/code/ubelt/dev/maintain/count_usage_freq.py
python ~/code/ubelt/dev/maintain/gen_api_for_docs.py --extra_modname=bioharn,watch --remove_zeros=False
python ~/code/ubelt/dev/maintain/gen_api_for_docs.py --extra_modnames=bioharn,geowatch --remove_zeros=False
# Then edit: TODO make less manual
~/code/ubelt/docs/source/function_usefulness.rst
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,9 @@ omit = [
"ubelt/_win32_links.py",
"*/setup.py",
]

[tool.codespell]
skip = ['./docs/build', './*.egg-info', './build', './htmlcov']
count = true
quiet-level = 3
ignore-words-list = ["fpr", 'ANS', 'ans']
3 changes: 2 additions & 1 deletion ubelt/util_deprecate.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ def schedule_deprecation(modname=None, name='?', type='?', migration='',
>>> # When less than the deprecated version this does nothing
>>> dummy_module.__version__ = '1.0.0'
>>> ub.schedule_deprecation(
... 'dummy_module', 'myfunc', 'function', 'do something else',
... modname='dummy_module', name='myfunc', type='function',
... migration='do something else',
... deprecate='1.1.0', error='1.2.0', remove='1.3.0')
>>> # But when the module version increases above the threshold,
>>> # the warning is raised.
Expand Down

0 comments on commit b8ca5ed

Please sign in to comment.