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

Fix ruff documentation violations in existing BioNeMo v2 code #59

Open
8 tasks
pstjohn opened this issue Jul 31, 2024 · 0 comments
Open
8 tasks

Fix ruff documentation violations in existing BioNeMo v2 code #59

pstjohn opened this issue Jul 31, 2024 · 0 comments
Assignees

Comments

@pstjohn
Copy link
Collaborator

pstjohn commented Jul 31, 2024

We should go back and fix ignored noqa: D*** violations in our code base to make our docstrings more consistent, and parseable by eventual documentation machinery.

Missing docstrings for functions / classes:

  • D101 public class docstring
  • D102 public method docstring
  • D103 public function docstring
  • D107 missing init docstring
  • D105 Missing docstring for magic method (i.e., __len__ or __getitem__). I could be convinced to ignore this 🤷

Mis-formatted docstrings:

  • D205 Needs a single-line summary, then blank line.
  • D415 first line needs to end in punctionation.
  • D417 Parameter missing from docstring
@pstjohn pstjohn self-assigned this Jul 31, 2024
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