Support type annotations
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 592
- Forks
- 199
- Avg merge
- 1d 16h
- 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.
nidaqmx-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
No files or tests are named. Start by reviewing the existing docstrings and the Python typing module to determine the scope of annotations needed; done should mean the documented type information is exposed as Python type annotations and can support tools such as mypy and editor completion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 32/100