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.

Sign up for GitHub

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

Jump to bottom

Ignore pydocstyle errors D100 and D103 on python unittest files #10

Open
JackKelly opened this issue Oct 29, 2021 · 2 comments
Open

Ignore pydocstyle errors D100 and D103 on python unittest files #10

JackKelly opened this issue Oct 29, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@JackKelly
Copy link
Member

JackKelly commented Oct 29, 2021 •
edited
Loading

Detailed Description

Ignore these two pydocstyle errors on python unittest files:

  • D100: Missing docstring in public module
  • D103: Missing docstring in public function

Context

Unittest functions rarely have module or function docstrings!

Implementation

Is it possible to ignore all python filenames with test in the filename?
@JackKelly JackKelly added the enhancement New feature or request label Oct 29, 2021
@JackKelly JackKelly moved this to Todo in Nowcasting Oct 29, 2021
@JackKelly JackKelly changed the title Ignore pydocstyle D100 and D103 on python unittest files Ignore pydocstyle errors D100 and D103 on python unittest files Oct 29, 2021
@flowirtz
Copy link
Contributor

Ha! I was wondering the same thing - this has annoyed me already as well.

@peterdudfield
Copy link
Contributor

Looks like you can enter an input folder, and if you make this the main project folder, then tests will be ignored
https://github.com/openclimatefix/.github/blob/main/.github/workflows/python-lint.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
No open projects
Nowcasting
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JackKelly @flowirtz @peterdudfield