Replace comments with string literals #46
Closed
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.
As outlined in #35, both
assert isinstance(…)
and syntactically relevant comments have severe drawbacks.Parallel to docstrings, using string literals for inline type hinting provides hints that eliminate those disadvantages:
assert isinstance(…)
orUndefined(…)
have)Also they are already used in e.g. PyCharm’s type hinting.
Open question: Do we prefer
or