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.

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

Add missing docs and enable flake8 corresponding checks #606

Open
8 tasks
lucekdudek opened this issue Jan 24, 2023 · 0 comments
Open
8 tasks

Add missing docs and enable flake8 corresponding checks #606

lucekdudek opened this issue Jan 24, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@lucekdudek
Copy link
Contributor

  • Enable Flake8's extend in pyproject.toml
  • Make checks_codestyle pass by adding missing docs

Extends:

  • D100 - Add missing docs to public modules
  • D101 - Add missing docs to public classes
  • D102- Add missing docs to public methods
  • D104 - Add missing docs to public packages
  • D105 - Add missing docs to magic methods
  • D107 - Add missing docs to init
  • D400 - End first lines of docs with periods
  • D403 - Capitalize first words of docs
@lucekdudek lucekdudek added the documentation Improvements or additions to documentation label Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant