Add typing hints documentation to python readme #70
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
Contributor
jumcorredorro
commented
Jun 1, 2022
jumcorredorro
commented
- Add typing hints documentation to Python README. Some examples and pros, cons items.
python/README.md
Outdated
|
|
||
| ### Cons of typing hints | ||
|
|
||
| * Will take developer time and effort to add. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Will take developer time and effort to add. | |
| * Will take developer time and effort to add it. |
python/README.md
Outdated
| ### Cons of typing hints | ||
|
|
||
| * Will take developer time and effort to add. | ||
| * Work best in modern versions of Python. Python 2.7 could use typed comments, but it were introduced since Python 3.0. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Work best in modern versions of Python. Python 2.7 could use typed comments, but it were introduced since Python 3.0. | |
| * Work best in modern versions of Python. Python 2.7 could use typed comments, but it was introduced in Python 3.0. |
|
|
||
| ### Typing: please remember | ||
|
|
||
| This typing concepts does not mean you HAVE to use static type checking in your code, there is a concept call [Gradual typing in PEP 483](https://peps.python.org/pep-0483/#summary-of-gradual-typing). This means that you can gradually introduce types into the code. Code without type hints will be ignored by the static type checker. Therefore, you can start adding types to critical components. |
Contributor
There was a problem hiding this comment.
Is the # in the URL causing issues?
Contributor
Author
There was a problem hiding this comment.
No, it doesn't cause any issues, I think is the formatting here.
ghost
approved these changes
Jun 3, 2022
brunomichetti
requested changes
Jun 3, 2022
Contributor
brunomichetti
left a comment
brunomichetti
left a comment
There was a problem hiding this comment.
Can you add the rules we discussed with Jorge?
The rules of where/when to use typing
brunomichetti
approved these changes
Jun 6, 2022
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.