Skip to content

Update server value docs for input_numeric input_date input_select #2022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update server value docs for input_numeric input_date input_select #2022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions shiny/ui/_input_date.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ def input_date(
Notes
------
::: {.callout-note title="Server value"}
A :class:`~datetime.date` object.
A :class:`~datetime.date` object or `None` if the user deletes the input field.
:::

See Also
Expand Down Expand Up @@ -223,7 +223,8 @@ def input_date_range(
Notes
------
::: {.callout-note title="Server value"}
A tuple of :class:`~datetime.date` objects.
A 2-element tuple containing :class:`~datetime.date` objects or `None`. Each tuple
element will be `None` if the user deletes the corresponding input field.
:::

See Also
Expand Down
2 changes: 1 addition & 1 deletion shiny/ui/_input_numeric.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def input_numeric(
Notes
------
::: {.callout-note title="Server value"}
A numeric value.
An `int`, `float` or `None` (if the user deletes the input field).
:::

See Also
Expand Down
4 changes: 1 addition & 3 deletions shiny/ui/_input_select.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,7 @@
_topics = {
"Server value": """
If `multiple=False`, the server value is a string with the value of the selected item.
If `multiple=True`, the server value is a tuple containing the values of the
selected items. When ``multiple=True`` and nothing is selected, this value
will be ``None``.
If `multiple=True`, the server value is a tuple of string(s) with the selected value(s) (if any).
"""
}

Expand Down