Skip to content

Commit a0d161f

Browse files
committed
Documentation update for *arg and **kwargs change
Closes #18
1 parent e429875 commit a0d161f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,10 @@ suggest ignoring some of the violation codes::
238238
# See https://github.com/peterjc/flake8-rst-docstrings/issues/17
239239
RST201,RST203,RST301,
240240

241+
Using ``*arg`` or ``**kwargs`` without escaping in argument descriptions has
242+
been special-cased to avoid triggering ``RST213`` and ``RST210`` respectively.
243+
However, other variable names used this way will trigger as missing closing
244+
markup for emphasis and strong, so you may have to ignore those codes as well.
241245

242246
Version History
243247
---------------

0 commit comments

Comments
 (0)