Add more documentation to special forms in `ty_extensions.pyi` stub
- Dominant language
- Python
- Stars
- 19.7k
- Forks
- 331
- Avg merge
- 23h 12m
- Merged PRs (30d)
- 44
Description
It's easy for users to jump to these definitions in the stub file from inlay hints. It will be even easier to jump to these definitions if something like https://github.com/astral-sh/ty/issues/1575 is implemented.
We should add more docstrings/comments to the stub file so that users have a better experience when they land there. Ideally we would also show this documentation on hover, so that users can easily learn about what the `Unknown` type means and represents, for example.
Contributor guide
Research direction
Start with the special-form definitions in ty_extensions.pyi and review the existing comments or docstrings. Add user-facing explanations for the definitions, including what the Unknown type means and represents; done means users landing on these definitions can understand them from the stub documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100