Skip to content

Commit

Permalink
fix: autodoc failures hotfix (deephaven#748)
Browse files Browse the repository at this point in the history
  • Loading branch information
AkshatJawne authored Aug 19, 2024
1 parent acf35ec commit dbcfef3
Show file tree
Hide file tree
Showing 13 changed files with 18 additions and 12 deletions.
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/checkbox.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ def checkbox(
Checkboxes allow users to select multiple items from a list of individual items, or to mark one individual item as selected.
Args:
children: The checkbox label.
*children: The checkbox label.
is_emphasized: This prop sets the emphasized style which provides visual prominence.
is_indeterminate: Indeterminism is presentational only. The indeterminate visual representation remains regardless of user interaction.
default_selected: Whether the element should be selected (uncontrolled).
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/content.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def content(
Content represents the primary content within a Spectrum container.
Args:
children: The content to render within the container.
*children: The content to render within the container.
flex: When used in a flex layout, specifies how the element will grow or shrink to fit the space available.
flex_grow: When used in a flex layout, specifies how the element will grow to fit the space available.
flex_shrink: When used in a flex layout, specifies how the element will shrink to fit the space available.
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/flex.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def flex(
Base Flex component for laying out children in a flexbox.
Args:
children: Elements to render in the flexbox.
*children: Elements to render in the flexbox.
flex: The flex property of the flexbox.
direction: The direction in which to layout children.
wrap: Whether children should wrap when they exceed the panel's width.
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/form.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def form(
Forms allow users to enter data that can be submitted while providing alignment and styling for form fields
Args:
children: The content to render within the container.
*children: The content to render within the container.
is_quiet: Whether the form should be quiet.
is_emphasized: Whether the form should be emphasized.
is_disabled: Whether the form should be disabled.
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/fragment.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ def fragment(*children: Any):
Used to group elements together without a wrapper node.
Args:
children: The children in the fragment.
*children: The children in the fragment.
"""
return component_element("Fragment", children=children)
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def grid(
A layout container using CSS grid. Supports Spectrum dimensions as values to ensure consistent and adaptive sizing and spacing.
Args:
children: The content to render within the container.
*children: The content to render within the container.
areas: The named grid areas to use for the grid.
rows: The row sizes for the grid.
columns: The column sizes for the grid.
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/heading.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def heading(
A layout container using CSS grid. Supports Spectrum dimensions as values to ensure consistent and adaptive sizing and spacing.
Args:
children: The content to render within the container.
*children: The content to render within the container.
level: Sets heading level, h1 through h6. Defaults to 3.
color: The color of the text.
flex: When used in a flex layout, specifies how the element will grow or shrink to fit the space available.
Expand Down
3 changes: 2 additions & 1 deletion plugins/ui/src/deephaven/ui/components/panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def panel(
A panel is a container that can be used to group elements.
Args:
children: Elements to render in the panel.
*children: Elements to render in the panel.
title: Title of the panel.
direction: The direction in which to layout children.
wrap: Whether children should wrap when they exceed the panel's width.
Expand All @@ -54,6 +54,7 @@ def panel(
padding_end: The padding to apply after the element.
padding_x: The padding to apply to the left and right of the element.
padding_y: The padding to apply to the top and bottom of the element.
"""

children, props = create_props(locals())
Expand Down
1 change: 1 addition & 0 deletions plugins/ui/src/deephaven/ui/components/picker.py
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ def picker(
Returns:
The rendered Picker.
"""

children, props = create_props(locals())

children, props = unpack_item_table_source(children, props, SUPPORTED_SOURCE_ARGS)
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/row.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def row(*children: Any, height: float | None = None, **kwargs: Any):
Each element will be placed to the right of its prior sibling.
Args:
children: Elements to render in the row.
*children: Elements to render in the row.
height: The percent height of the row relative to other children of its parent. If not provided, the row will be sized automatically.
"""
return component_element("Row", *children, height=height, **kwargs)
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/stack.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def stack(
Each element will get a tab and only one element can be visible at a time.
Args:
children: Elements to render in the row.
*children: Elements to render in the row.
height: The percent height of the stack relative to other children of its parent. If not provided, the stack will be sized automatically.
width: The percent width of the stack relative to other children of its parent. If not provided, the stack will be sized automatically.
"""
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def text(
Text represents text with no specific semantic meaning.
Args:
children: Text content.
*children: Text content.
color: The color of the text.
flex: When used in a flex layout, specifies how the element will grow or shrink to fit the space available.
flex_grow: When used in a flex layout, specifies how the element will grow to fit the space available.
Expand Down
6 changes: 5 additions & 1 deletion plugins/ui/src/deephaven/ui/components/view.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def view(
View is a general purpose container with no specific semantics that can be used for custom styling purposes. It supports Spectrum style props to ensure consistency with other Spectrum components.
Args:
children: The content to render within the container.
*children: The content to render within the container.
element_type: The type of element to render.
flex: When used in a flex layout, specifies how the element will grow or shrink to fit the space available.
flex_grow: When used in a flex layout, specifies how the element will grow to fit the space available.
Expand Down Expand Up @@ -162,7 +162,11 @@ def view(
id: The unique identifier of the element.
UNSAFE_class_name: A CSS class to apply to the element.
UNSAFE_style: A CSS style to apply to the element.
Returns:
The rendered view.
"""

return component_element(
"View",
children=children,
Expand Down

0 comments on commit dbcfef3

Please sign in to comment.