Include type hints in documentation
@Thom1729 is already working on this.
Since May 24, 2020.
Assessment
This issue has not been assessed yet.
Description
The issue mentioned in https://github.com/SublimeText/sublime_lib/issues/118#issuecomment-499098498 for improving type hint rendering through sphinx has been closed (https://github.com/sphinx-doc/sphinx/issues/5868). From my understanding, this should allow us to add type hints to the documentation without the rendering problems that had been encountered before.
- Dominant language
- Python
- Stars
- 56
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
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.
More from SublimeText/sublime_lib
-
documentation
Difficulty 3/5 1-2 days Newbie friendliness 35/100
SublimeText/sublime_lib#183 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 38/100
SublimeText/sublime_lib#173 · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
SublimeText/sublime_lib#164 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
SublimeText/sublime_lib#141 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
SublimeText/sublime_lib#139 · 4 comments ·
All issues in SublimeText/sublime_lib
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100