Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Add D419: Add and switch to "Docstring is empty" error code #559

Merged
merged 5 commits into from
Dec 30, 2021

Conversation

thejcannon
Copy link
Contributor

Reporting D10X errors for empty docstrings is doubly misleading:

  1. The docstring isn't missing. It's empty.
  2. The D10X errors use public, but could be reported on private definitions.

Please make sure to check for the following items:

  • Add unit tests and integration tests where applicable.
  • Add a line to the release notes (docs/release_notes.rst) under "Current Development Version".

sambhav
sambhav previously approved these changes Dec 30, 2021
@thejcannon
Copy link
Contributor Author

The error doesn't seem related to my changes:

Traceback (most recent call last):
  File "/home/runner/work/pydocstyle/pydocstyle/.tox/py/bin/black", line 5, in <module>
    from black import patched_main
  File "/home/runner/work/pydocstyle/pydocstyle/.tox/py/lib/python3.10/site-packages/black/__init__.py", line 52, in <module>
    from typed_ast import ast3, ast27
  File "/home/runner/work/pydocstyle/pydocstyle/.tox/py/lib/python3.10/site-packages/typed_ast/ast3.py", line 40, in <module>
    from typed_ast import _ast3
ImportError: /home/runner/work/pydocstyle/pydocstyle/.tox/py/lib/python3.10/site-packages/typed_ast/_ast3.cpython-310-x86_64-linux-gnu.so: undefined symbol: _PyUnicode_DecodeUnicodeEscape
ERROR: InvocationError for command /home/runner/work/pydocstyle/pydocstyle/.tox/py/bin/black --check src/pydocstyle (exited with code 1)

@sambhav
Copy link
Member

sambhav commented Dec 30, 2021

Yup - trying to fix it at #565

@sambhav sambhav merged commit 8dee619 into PyCQA:master Dec 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants