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

increase docstring coverage #129

Closed
2 tasks
drbenvincent opened this issue Dec 19, 2022 · 4 comments
Closed
2 tasks

increase docstring coverage #129

drbenvincent opened this issue Dec 19, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@drbenvincent
Copy link
Collaborator

After #124

  • increase the number of docstrings, now evaluated with interrogate
  • ratchet up fail-under = 40 to a higher number in pyproject.toml
  • Don't include type information because that is given in the type hints which are (or will be in the function signature)
@drbenvincent drbenvincent added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 19, 2022
@drbenvincent drbenvincent added this to the Pay off technical debt milestone Dec 19, 2022
@jpreszler
Copy link
Contributor

I've begun work on this to learn the package better. I should have it done within the next week - getting the example usages will take a little time.

@drbenvincent
Copy link
Collaborator Author

Fantastic. Expecting the birth of our first child any moment now, so excuse any delays in reviewing the PR.

@jpreszler
Copy link
Contributor

There's the PR. In retrospect, I probably should have done it in chunks because it's fairly large.

Between the new addition to your family (I hope everything will go, or has gone, smoothly) and the size of this, I'm not expecting a quick review. Hopefully the fact that you wrote the code this documents means the review isn't as bad as if I was adding 1K lines of code :)

Please don't hesitate to flag changes you would like or inconsistencies you see.

@drbenvincent
Copy link
Collaborator Author

Closed by #232

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants