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 documentation #67

Closed
4 of 5 tasks
dstansby opened this issue Apr 19, 2023 · 3 comments
Closed
4 of 5 tasks

Add documentation #67

dstansby opened this issue Apr 19, 2023 · 3 comments
Assignees
Labels
Docs Improvements or additions to documentation
Milestone

Comments

@dstansby dstansby added the Docs Improvements or additions to documentation label Apr 19, 2023
@dstansby dstansby self-assigned this May 2, 2023
@samcunliffe
Copy link
Collaborator

samcunliffe commented May 2, 2023

Only softly related to the docs, but if you like this comment enough to make a subtask: I'd put it here rather than elsewhere.

... As you're adding docstrings, is it worth adding type hints?

Could then add a mypy type check to the CI...? From my memory, this is quite easy with pre-commit.

A possible disadvantage is the change between 3.8 and 3.9 where the typing.List[] and other standard collections were deprecated. Unsure how annoying this would be.

@dstansby
Copy link
Member Author

dstansby commented May 3, 2023

I'm 👍 to type hints - looks like I already added a bunch, but never added mypy to pre-commit. I'll open a new issue to track this.

@dstansby dstansby added this to the 0.3.0 milestone May 18, 2023
@dstansby
Copy link
Member Author

Don't think the final item will get done before this project finishes, so going to close this tracker issue as done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Improvements or additions to documentation
Projects
No open projects
Development

No branches or pull requests

2 participants