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

Outstanding checks for pre-commit #96

Open
21 tasks
HGWright opened this issue Nov 22, 2024 · 0 comments
Open
21 tasks

Outstanding checks for pre-commit #96

HGWright opened this issue Nov 22, 2024 · 0 comments

Comments

@HGWright
Copy link

Repo-review

  • "PC170", # PyGrep hooks
  • "PC180", # Uses prettier
  • "PY004", # Test folder location
  • "RTD", # ReadTheDocs

Numpydoc

  • "GL01", # Permit summary line on same line as docstring opening quotes.
  • "GL02", # Permit a blank line before docstring closing quotes.
  • "GL03", # Ignoring.
  • "SA01", # Not all docstrings require a "See Also" section.
  • "ES01", # Not all docstrings require an "Extended Summary" section.
  • "EX01", # Not all docstrings require an "Examples" section.
  • "YD01", # Not all docstrings require a "Yields" section.

Ruff

  • "COM812", # Trailing comma missing.
  • "COM819", # Trailing comma prohibited.
  • "ISC001", # Implicitly concatenate string literals on one line.

Per File

Tests

  • "D100", # Missing docstring in public module.
  • "D101", # Missing docstring in public class.
  • "D102", # Missing docstring in public method.
  • "D205", # 1 blank line required between summary line and description.
  • "D401", # 1 First line of docstring should be in imperative mood.
  • "ANN", # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann.
  • "S101", # Use of assert detected.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant