[WIP] Improve documentation for cards #2054
Draft
+421
−121
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
Also removes dangerous default values
romain-intel
force-pushed
the
fix/documentcards
branch
from
4899b12
to
9e409e0
Compare
valayDave
requested changes
Sep 26, 2024
| @@ -179,18 +206,23 @@ def __init__( | |||
| @classmethod | |||
| def from_dataframe( | |||
| cls, | |||
| dataframe=None, | |||
| dataframe: Optional["pandas.DataFrame"] = None, | |||
There was a problem hiding this comment.
Suggested change
| dataframe: Optional["pandas.DataFrame"] = None, | |
| dataframe:"pandas.DataFrame", |
There was a problem hiding this comment.
I applied it but this does change the current UX. I agree the None made no sense but just mentioning.
| def __init__(self, src=None, label=None, disable_updates: bool = True): | ||
| def __init__( | ||
| self, | ||
| src: Optional[bytes] = None, |
There was a problem hiding this comment.
Suggested change
| src: Optional[bytes] = None, | |
| src: bytes, |
| self._text = text | ||
|
|
||
| def __init__(self, text=None): | ||
| def __init__(self, text: Optional[str] = None): |
There was a problem hiding this comment.
Suggested change
| def __init__(self, text: Optional[str] = None): | |
| def __init__(self, text: str): |
| @@ -770,19 +882,32 @@ class VegaChart(UserComponent): | |||
|
|
|||
| REALTIME_UPDATABLE = True | |||
|
|
|||
| def __init__(self, spec: dict, show_controls: bool = False): | |||
| def __init__( | |||
| self, spec: Union[Dict[Any, Any], "altair.Chart"], show_controls: bool = False | |||
There was a problem hiding this comment.
Suggested change
| self, spec: Union[Dict[Any, Any], "altair.Chart"], show_controls: bool = False | |
| self, spec: Dict[Any, Any], show_controls: bool = False |
There was a problem hiding this comment.
I am a bit confused here. Can't it take an altair.Chart like the update method?
There was a problem hiding this comment.
There is a class method for that.
|
|
||
| Parameters | ||
| ---------- | ||
| spec : Union[Dict[Any, Any], altair.Chart] |
There was a problem hiding this comment.
Suggested change
| spec : Union[Dict[Any, Any], altair.Chart] | |
| spec : Dict[Any, Any] |
valayDave
force-pushed
the
fix/documentcards
branch
from
6338d8d
to
fd72aa7
Compare
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.
Also removes dangerous default values