Support type annotations
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Python 3 supports optional type annotations using the typing module.
Benefits of specifying type annotations:
- Clients can use external tools like mypy to perform static type-checking.
- Editors such as Visual Studio Code use type annotations to provide auto-complete suggestions.
nimi-python already documents types in docstrings, so the information is already there. It would only need to be output in a different format.
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
Start by reviewing how nimi-python currently documents types in docstrings and how that information is exposed in its driver APIs. Determine the annotation format and scope needed for Python 3 typing support, then verify that external tools such as mypy and editor auto-completion can consume the generated annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100