Skip to content

Commit

Permalink
chore(hardware): Remove docstring content checks (#12128)
Browse files Browse the repository at this point in the history
These were mostly annoying and entirely surface level and trip up so
many PRs and who cares.

The removed ones are

D400 | First line should end with a period
D401 | First line should be in imperative mood
D401 | First line should be in imperative mood; try rephrasing
D403 | First word of the first line should be properly capitalized
D404 | First word of the docstring should not be This
D415 | First line should end with a period, question mark, or exclamation point
D105 | Missing docstring in magic method
  • Loading branch information
sfoster1 committed Feb 10, 2023
1 parent 725f84f commit dc285e5
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions hardware/.flake8
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ extend-ignore =
# do not require type annotations for self nor cls
ANN101,
ANN102
# do not grammar pedant me any more
D400,
D401,
D403,
D404,
D415,
# there's no need to mandate docstrings in like __add__ (note that __init__
# is covered separately by D107)
D105,

# configure flake8-docstrings
# https://pypi.org/project/flake8-docstrings/
Expand Down

0 comments on commit dc285e5

Please sign in to comment.