From acf4969a055c88de000b403e6d0fc1a6e2fc4dda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9on=20Avic=20Simmons?= Date: Fri, 23 Oct 2026 08:36:22 -0400 Subject: [PATCH] docs: fix typos and grammar in component docstrings and comments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Léon Avic Simmons --- docs/rcweb/rcweb/utils/blocks/code.py | 1 - reflex_chakra/components/base.py | 2 +- reflex_chakra/components/forms/pininput.py | 2 +- reflex_chakra/components/forms/rangeslider.py | 2 +- reflex_chakra/components/overlay/menu.py | 4 ++-- reflex_chakra/components/overlay/menu.pyi | 4 ++-- reflex_chakra/components/overlay/popover.py | 4 ++-- reflex_chakra/components/overlay/popover.pyi | 2 +- 8 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/rcweb/rcweb/utils/blocks/code.py b/docs/rcweb/rcweb/utils/blocks/code.py index 59cb541..f1a45fe 100644 --- a/docs/rcweb/rcweb/utils/blocks/code.py +++ b/docs/rcweb/rcweb/utils/blocks/code.py @@ -134,7 +134,6 @@ def doccmdoutput( Args: command: The command to display. output: The output of the command. - theme: The theme of the component. Returns: The styled command and its example output. diff --git a/reflex_chakra/components/base.py b/reflex_chakra/components/base.py index 493ec76..3d62c73 100644 --- a/reflex_chakra/components/base.py +++ b/reflex_chakra/components/base.py @@ -50,7 +50,7 @@ def create(cls, *children, **props) -> Component: Returns: A new Chakra component. """ - # copy color mode provider file to client's asset dir if it doesnt exist. + # copy color mode provider file to client's asset dir if it doesn't exist. client_asset_dir = Path.cwd() / constants.ASSETS_DIR_NAME if ( not ( diff --git a/reflex_chakra/components/forms/pininput.py b/reflex_chakra/components/forms/pininput.py index 8d9621c..94178a1 100644 --- a/reflex_chakra/components/forms/pininput.py +++ b/reflex_chakra/components/forms/pininput.py @@ -105,7 +105,7 @@ def _get_ref_hook(self): """Override the base _get_ref_hook to handle array refs. Returns: - The overrided hooks. + The overridden hooks. """ if self.id: ref = format.format_array_ref(self.id, None) diff --git a/reflex_chakra/components/forms/rangeslider.py b/reflex_chakra/components/forms/rangeslider.py index 3edb728..3fad7b9 100644 --- a/reflex_chakra/components/forms/rangeslider.py +++ b/reflex_chakra/components/forms/rangeslider.py @@ -69,7 +69,7 @@ def _get_ref_hook(self): """Override the base _get_ref_hook to handle array refs. Returns: - The overrided hooks. + The overridden hooks. """ if self.id: ref = format.format_array_ref(self.id, None) diff --git a/reflex_chakra/components/overlay/menu.py b/reflex_chakra/components/overlay/menu.py index 791f88b..9deb462 100644 --- a/reflex_chakra/components/overlay/menu.py +++ b/reflex_chakra/components/overlay/menu.py @@ -88,7 +88,7 @@ def create( Args: *children: The children of the component. - button: the button that open the menu. + button: the button that opens the menu. items (list): The items of the menu. **props: The properties of the component. @@ -135,7 +135,7 @@ def create(cls, *children, items: list | None = None, **props) -> Component: Args: *children: The children of the component. - items: A list of item to add as child of the component. + items: A list of items to add as child of the component. **props: The properties of the component. Returns: diff --git a/reflex_chakra/components/overlay/menu.pyi b/reflex_chakra/components/overlay/menu.pyi index 43c6dac..57a4c0c 100644 --- a/reflex_chakra/components/overlay/menu.pyi +++ b/reflex_chakra/components/overlay/menu.pyi @@ -81,7 +81,7 @@ class Menu(ChakraComponent): Args: *children: The children of the component. - button: the button that open the menu. + button: the button that opens the menu. items (list): The items of the menu. arrow_padding: The padding required to prevent the arrow from reaching the very edge of the popper. auto_select: If true, the first enabled menu item will receive focus and be selected when the menu opens. @@ -208,7 +208,7 @@ class MenuList(ChakraComponent): Args: *children: The children of the component. - items: A list of item to add as child of the component. + items: A list of items to add as child of the component. style: The style of the component. key: A unique key for the component. id: The id for the component. diff --git a/reflex_chakra/components/overlay/popover.py b/reflex_chakra/components/overlay/popover.py index 2c823b2..696dc81 100644 --- a/reflex_chakra/components/overlay/popover.py +++ b/reflex_chakra/components/overlay/popover.py @@ -34,7 +34,7 @@ class Popover(ChakraComponent): # The boundary area for the popper. Used within the preventOverflow modifier boundary: Var[str] - # If true, the popover will close when you blur out it by clicking outside or tabbing out + # If true, the popover will close when you blur out of it by clicking outside or tabbing out close_on_blur: Var[bool] # If true, the popover will close when you hit the Esc key @@ -79,7 +79,7 @@ class Popover(ChakraComponent): # The CSS positioning strategy to use. ("fixed" | "absolute") strategy: Var[LiteralMenuStrategy] - # The interaction that triggers the popover. hover - means the popover will open when you hover with mouse or focus with keyboard on the popover trigger click - means the popover will open on click or press Enter to Space on keyboard ("click" | "hover") + # The interaction that triggers the popover. hover - means the popover will open when you hover with mouse or focus with keyboard on the popover trigger click - means the popover will open on click or press Enter or Space on keyboard ("click" | "hover") trigger: Var[LiteralPopOverTrigger] # Fired when the popover is closed. diff --git a/reflex_chakra/components/overlay/popover.pyi b/reflex_chakra/components/overlay/popover.pyi index befa3f9..02e9d84 100644 --- a/reflex_chakra/components/overlay/popover.pyi +++ b/reflex_chakra/components/overlay/popover.pyi @@ -97,7 +97,7 @@ class Popover(ChakraComponent): arrow_size: The size of the popover arrow auto_focus: If true, focus will be transferred to the first interactive element when the popover opens boundary: The boundary area for the popper. Used within the preventOverflow modifier - close_on_blur: If true, the popover will close when you blur out it by clicking outside or tabbing out + close_on_blur: If true, the popover will close when you blur out of it by clicking outside or tabbing out close_on_esc: If true, the popover will close when you hit the Esc key default_is_open: If true, the popover will be initially opened. direction: Theme direction ltr or rtl. Popper's placement will be set accordingly