Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mod as permitted RST role #807

Merged
merged 1 commit into from
Jan 27, 2022
Merged

Conversation

cidrblock
Copy link
Collaborator

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

@cidrblock
Copy link
Collaborator Author

recheck

@cidrblock cidrblock added the gate label Jan 27, 2022
Copy link
Contributor

@ansible-zuul ansible-zuul bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ansible-zuul ansible-zuul bot merged commit 303f3ba into ansible:main Jan 27, 2022
ssbarnea pushed a commit to ssbarnea/ansible-navigator that referenced this pull request Feb 12, 2022
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants