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

Skip D401 for docstrings that start directly with a section. #556

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Nov 10, 2021

Skip D401 for docstrings that start directly with a section. Closes #463.

Please make sure to check for the following items:

  • Add unit tests and integration tests where applicable.
    If you've added an error code or changed an error code behavior,
    you should probably add or change a test case file under tests/test_cases/ and add
    it to the list under tests/test_definitions.py.
    If you've added or changed a command line option,
    you should probably add or change a test in tests/test_integration.py.
  • Add a line to the release notes (docs/release_notes.rst) under "Current Development Version".
    Make sure to include the PR number after you open and get one.

Please don't get discouraged as it may take a while to get a review.

(afaict the test failure on py3.9 is spurious)

@anntzer anntzer changed the title Sections Skip D401 for docstrings that start directly with a section. Nov 10, 2021
@anntzer
Copy link
Contributor Author

anntzer commented Aug 28, 2023

Kindly bumping.

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.

Spurious D401 when docstring only contains a Returns section
1 participant