Type annotation guidelines
Open
Nobody has claimed this yet.
topic-documentation
topic-typing
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
Dask has a pretty nice guideline for type hinting, see https://github.com/dask/community/issues/255.
Notable for us is to avoid adding typing in docstrings to avoid duplicating information.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no xarray file, test, or documentation entry point. Start by reading Dask community issue #255 and reviewing xarray's existing type annotations and docstrings; done means an agreed xarray guideline is documented, including the rule against duplicating type information in docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100