Properly annotate types on `ts`, `Node`, `Edge`, and `Struct` types so that autocompletion and intellisense tools work correctly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 441
- Forks
- 90
- Avg merge
- 1d 12m
- Merged PRs (30d)
- 5
Description
csp nodes and graphs are type-annotated to return ts["T"], and are then connected to other nodes/graphs. Additionally, the return value of these ts["T"] which is an Edge, has a number of of convenience methods such as those in https://github.com/Point72/csp/issues/40, a number of operators, and more to come including those in https://github.com/Point72/csp/pull/60. Finally, csp.Struct is statically typed and should integrate properly in intellisense tools.
We should look to the tools themselves to see how to best integrate:
https://github.com/microsoft/vscode-python/issues/2446
https://github.com/microsoft/python-language-server/issues/260
Contributor guide
No contributing guide indexed for this repository
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 the existing annotations for csp's ts, Node, Edge, and Struct types, then consult the linked VS Code Python and Python language server discussions. Done means autocomplete and IntelliSense correctly understand these types, Edge convenience methods and operators, and statically typed csp.Struct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- stream-processing
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100