Skip to content

Commit

Permalink
DOC: Silence traitlets nitpicky warning
Browse files Browse the repository at this point in the history
  • Loading branch information
dopplershift committed Sep 18, 2023
1 parent 155d213 commit 3a7ba94
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,16 @@
('py:class', 'M'), ('py:class', 'N'), ('py:class', 'P'), ('py:class', '2'),
('py:class', 'optional'), ('py:class', 'array-like'), ('py:class', 'file-like object'),
# For traitlets docstrings
('py:class', 'All'), ('py:class', 'callable'),
('py:class', 'All'), ('py:class', 't.Any'), ('py:class', 't.Iterable'),
# Next two are from Python dict docstring that we inherit
('py:class', 'a shallow copy of D'),
('py:class', 'v, remove specified key and return the corresponding value.')
]

nitpick_ignore_regex = [
('py:class', r'default:.*'), # For some traitlets docstrings
('py:class', r'.*Sentinel'),
('py:class', r'.*[cC]allable'),
('py:class', r'.*object providing a view on.*'), # Python dict docstring
('py:class', r'None. .*'), # Python dict docstring
('py:class', r'.*D\[k\].*'), # Python dict docstring
Expand Down

0 comments on commit 3a7ba94

Please sign in to comment.