Skip to content

Remove docstring first check from pre-commit #1025

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

Merged
merged 2 commits into from
Feb 28, 2022

Conversation

cidrblock
Copy link
Collaborator

@cidrblock cidrblock commented Feb 28, 2022

It conflicts when the PEP257 attribute naming convention is used to document either a TypeAlias or NewType.

Related: pre-commit/pre-commit-hooks#159

String literals occurring immediately after a simple assignment at the top level of a module, class, or __init__ method are called "attribute docstrings".
Ref: https://www.python.org/dev/peps/pep-0257/#id4

As seen here: https://results.pre-commit.ci/run/github/320052445/1646080610.D81bOX7LQLakCKvAoaxx_A

because of:

https://github.com/ansible/ansible-navigator/pull/1024/files#diff-876f32fdc126136789ecfd4484fd9e4950a5faf7fb8fa3cefcff7ac6f6b7ac50R27

@cidrblock cidrblock merged commit a6fc984 into ansible:main Feb 28, 2022
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