Skip to content

Commit

Permalink
mod (ansible#807)
Browse files Browse the repository at this point in the history
Add `mod` as permitted RST role

This adds mod to the user list of sphinx roles in the flake8 file.  It was being reported by flake8-rst-docstring whcih is being vetted as it is included in the wemake style guide.
This was the error begin reported:
tests/unit/test_utils.py:1:1: RST304 Unknown interpreted text role "mod".
"""Test the functions exposed in the :mod:`~ansible_navigator.utils` subpackage."""
^

Some good info about this is here: peterjc/flake8-rst-docstrings#16

Reviewed-by: Rick Elrod <[email protected]>
Reviewed-by: None <None>
  • Loading branch information
cidrblock authored and ssbarnea committed Jan 30, 2022
1 parent 72c5470 commit 30bac47
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,7 @@ rst-roles =
data,
exc,
meth,
mod,
term,
py:class,
py:data,
Expand Down

0 comments on commit 30bac47

Please sign in to comment.