Typehints etc: Not yet the docstrings, but the base to create docstrings #161
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
signedav
changed the title
Member
Author
|
My goal was to invest a day in documentation of the library, like with docstrings etc. But in the end the docstrings are massively easier to generate when there are already proper typehints. And for working with the library they are at least as valuable. So these are at least the typehints of all the functions. |
Header format in proper py docsting style Header docstring in proper format headers of processing
…checked by real code monkey
Type hints for iliwrapper Typehints for generator Type hints for utils Type hints for ilitoppingmaker
signedav
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If time left
Generate docstrings templates according to type hints with AIFill up docstrings templates manually