docs: Fix and improve alt.Optional doc#3449
Merged
Conversation
Fixes an issue identified in vega#3431 (comment) and addresses `typing.Optional`
dangotbanned
commented
Jun 28, 2024
dangotbanned
commented
Jun 28, 2024
dangotbanned
added a commit
to dangotbanned/altair
that referenced
this pull request
Jul 3, 2024
The user will see this message ``` altair\utils\data.py:17:5: TID251 `typing.Optional` is banned: Use `Union[T, None]` instead. `typing.Optional` is likely to be confused with `altair.Optional`, which have similar but different semantic meaning. See vega#3449 Found 1 error. ``` Partial fix for vega#3452 (comment)
binste
pushed a commit
that referenced
this pull request
Jul 3, 2024
* feat(typing): Ban `typing.Optional` import using `ruff` The user will see this message ``` altair\utils\data.py:17:5: TID251 `typing.Optional` is banned: Use `Union[T, None]` instead. `typing.Optional` is likely to be confused with `altair.Optional`, which have similar but different semantic meaning. See #3449 Found 1 error. ``` Partial fix for #3452 (comment) * fix: typo in message
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes an issue identified in #3431 (comment) and addresses
typing.OptionalThis is a follow-up PR to #3431, following @binste comment