Clarify documentation for typing extension
#4549
Merged
Conversation
This file contains 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
pylint/extensions/typing.py
Outdated
| "3.7 - 3.9" | ||
| "Set to ``no`` if the app / library does NOT need to " | ||
| "support runtime introspection of type annotations. " | ||
| "Only change it if you understand what that means. " |
There was a problem hiding this comment.
Could we explain "what that means" or link to the doc that explains it here ? :)
There was a problem hiding this comment.
My initial idea was something along the lines:
If you don't know what that means, you're probably better off to leave it as is.
I just wasn't sure this would be the right tone. It's never the less true. This should really only be set if the user fully understands the consequences. Not knowing runtime introspection is a clear signal that he/she doesn't know enough.
There was a problem hiding this comment.
Sure, but this is the place where we should link to where you need to look if you want to try to understand, no ?
There was a problem hiding this comment.
@Pierre-Sassoulas I've updated the explanation. Please take a look and let me know what you think
Pierre-Sassoulas
approved these changes
Jun 10, 2021
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.
Description
Clarify documentation for
typingextension.Type of Changes
Related Issue
Closes #4545