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

Tech-debt, add Numpy formatted docstrings and type hints to methods #56

Closed
1 of 8 tasks
jtyoung84 opened this issue Oct 20, 2022 · 0 comments
Closed
1 of 8 tasks
Labels
documentation Improvements or additions to documentation

Comments

@jtyoung84
Copy link
Collaborator

jtyoung84 commented Oct 20, 2022

User story

As a user, I want to see documentation about the input parameters of a method, so I can understand how to use it easier.
As a developer, I want clean, well-documented code, so I can maintain it easier.

Acceptance criteria

  • Interrogate report has 100% coverage
  • Automate way to check that type hints are included in all the function signatures.

Sprint Ready Checklist

    • Acceptance criteria defined
    • Team understands acceptance criteria
    • Team has defined solution / steps to satisfy acceptance criteria
    • Acceptance criteria is verifiable / testable
    • External / 3rd Party dependencies identified
    • Ticket is prioritized and sized

Notes

https://peps.python.org/pep-0484/

@jtyoung84 jtyoung84 added the documentation Improvements or additions to documentation label Oct 20, 2022
@dyf dyf closed this as completed Oct 31, 2022
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

2 participants