instruction stringclasses 100
values | code stringlengths 78 193k | response stringlengths 259 170k | file stringlengths 59 203 |
|---|---|---|---|
Add minimal docstrings for each function |
from __future__ import annotations
import dataclasses
import textwrap
from collections.abc import Callable, Sequence
from functools import lru_cache
from hashlib import md5
from types import SimpleNamespace
from typing import Any
from reflex.components.component import (
BaseComponent,
Component,
Compone... | --- +++ @@ -1,3 +1,4 @@+"""Markdown component."""
from __future__ import annotations
@@ -36,6 +37,7 @@
class Plugin(SimpleNamespace):
+ """Create new remark/rehype plugin or access pre-wrapped plugins."""
@staticmethod
def create(
@@ -44,6 +46,17 @@ additional_imports: dict[str, ImportTy... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/markdown/markdown.py |
Add docstrings for internal functions |
from reflex.constants.base import REFLEX_VAR_OPENING_TAG
from reflex.constants.colors import (
COLORS,
MAX_SHADE_VALUE,
MIN_SHADE_VALUE,
Color,
ColorType,
ShadeType,
)
from reflex.vars.base import Var
def color(
color: ColorType | Var[str],
shade: ShadeType | Var[int] = 7,
alpha: ... | --- +++ @@ -1,3 +1,4 @@+"""The colors used in Reflex are a wrapper around https://www.radix-ui.com/colors."""
from reflex.constants.base import REFLEX_VAR_OPENING_TAG
from reflex.constants.colors import (
@@ -16,6 +17,19 @@ shade: ShadeType | Var[int] = 7,
alpha: bool | Var[bool] = False,
) -> Color:
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/core/colors.py |
Create docstrings for each class method |
from __future__ import annotations
import asyncio
import concurrent.futures
import operator
import traceback
from collections.abc import Mapping, Sequence
from datetime import datetime
from pathlib import Path
from typing import Any, TypedDict
from urllib.parse import urlparse
from reflex import constants
from refle... | --- +++ @@ -1,3 +1,4 @@+"""Common utility functions used in the compiler."""
from __future__ import annotations
@@ -33,6 +34,19 @@
def compile_import_statement(fields: list[ImportVar]) -> tuple[str, list[str]]:
+ """Compile an import statement.
+
+ Args:
+ fields: The set of fields to import from ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/compiler/utils.py |
Generate docstrings for this script |
from importlib.util import find_spec
if find_spec("pydantic") and find_spec("pydantic.v1"):
from pydantic.v1 import BaseModel
from reflex.utils.compat import ModelMetaclassLazyAnnotations
class Base(BaseModel, metaclass=ModelMetaclassLazyAnnotations):
class Config:
arbitrary_types_... | --- +++ @@ -1,3 +1,4 @@+"""Define the base Reflex class."""
from importlib.util import find_spec
@@ -7,14 +8,24 @@ from reflex.utils.compat import ModelMetaclassLazyAnnotations
class Base(BaseModel, metaclass=ModelMetaclassLazyAnnotations):
+ """The base class subclassed by all Reflex classes.
+
... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/base.py |
Add docstrings to my Python code |
from __future__ import annotations
from collections.abc import Iterator, Sequence
from typing import Any
from reflex.components.component import BaseComponent, Component, ComponentStyle
from reflex.components.tags import Tag
from reflex.components.tags.tagless import Tagless
from reflex.environment import Performanc... | --- +++ @@ -1,3 +1,4 @@+"""A bare component."""
from __future__ import annotations
@@ -18,10 +19,23 @@
@once
def get_performance_mode():
+ """Get the performance mode.
+
+ Returns:
+ The performance mode.
+ """
return environment.REFLEX_PERF_MODE.get()
def validate_str(value: str):
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/base/bare.py |
Add docstrings that explain logic |
from __future__ import annotations
from collections.abc import Sequence
from typing import Any, ClassVar, Literal
from reflex.components.component import Component, ComponentNamespace
from reflex.components.core.colors import color
from reflex.components.core.cond import cond
from reflex.components.lucide.icon impor... | --- +++ @@ -1,3 +1,4 @@+"""Radix accordion components."""
from __future__ import annotations
@@ -29,6 +30,15 @@ variant: Var[LiteralAccordionVariant] | LiteralAccordionVariant,
*selectors: str,
) -> str:
+ """Create a multi CSS selector for targeting variant against the given selectors.
+
+ Args:
+... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/primitives/accordion.py |
Create docstrings for each class method |
from typing import Any, ClassVar
from reflex.components.component import ComponentNamespace
from reflex.components.el import elements
from reflex.constants.compiler import MemoizationMode
from reflex.event import EventHandler, no_args_event_spec, passthrough_event_spec
from reflex.vars.base import Var
from .base imp... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/react-dialog."""
from typing import Any, ClassVar
@@ -11,11 +12,13 @@
class DialogElement(RadixPrimitiveComponent):
+ """Base class for all @radix-ui/react-dialog components."""
library = "@radix-ui/react-dialog@1.1.15"
clas... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/primitives/dialog.py |
Add verbose docstrings with examples |
from __future__ import annotations
from typing import Any
from reflex.components.component import Component, ComponentNamespace
from reflex.components.core.colors import color
from reflex.components.radix.primitives.accordion import DEFAULT_ANIMATION_DURATION
from reflex.components.radix.primitives.base import Radix... | --- +++ @@ -1,3 +1,4 @@+"""Progress."""
from __future__ import annotations
@@ -12,11 +13,13 @@
class ProgressComponent(RadixPrimitiveComponentWithClassName):
+ """A Progress component."""
library = "@radix-ui/react-progress@1.1.8"
class ProgressRoot(ProgressComponent):
+ """The Progress Root ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/primitives/progress.py |
Add structured docstrings to improve clarity |
from __future__ import annotations
from typing import Any, Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.debounce import DebounceInput
from reflex.components.el.elements.forms import Form as HTMLForm
from reflex.components.radix.themes.components.text_field import Tex... | --- +++ @@ -1,3 +1,4 @@+"""Radix form component."""
from __future__ import annotations
@@ -14,11 +15,13 @@
class FormComponent(RadixPrimitiveComponentWithClassName):
+ """Base class for all @radix-ui/react-form components."""
library = "@radix-ui/react-form@0.1.8"
class FormRoot(FormComponent, H... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/primitives/form.py |
Write clean docstrings for readability |
from reflex.components.component import Component
class StrictMode(Component):
library = "react"
tag = "StrictMode" | --- +++ @@ -1,8 +1,10 @@+"""Module for the StrictMode component."""
from reflex.components.component import Component
class StrictMode(Component):
+ """A React strict mode component to enable strict mode for its children."""
library = "react"
- tag = "StrictMode"+ tag = "StrictMode"
| https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/base/strict_mode.py |
Add docstrings to improve readability |
from __future__ import annotations
import functools
import inspect
from collections.abc import Callable, Iterable
from hashlib import md5
from typing import Any
from reflex.components.base.fragment import Fragment
from reflex.components.component import Component, field
from reflex.components.core.cond import cond
f... | --- +++ @@ -1,3 +1,4 @@+"""Create a list of components from an iterable."""
from __future__ import annotations
@@ -20,12 +21,15 @@
class ForeachVarError(TypeError):
+ """Raised when the iterable type is Any."""
class ForeachRenderError(TypeError):
+ """Raised when there is an error with the foreach ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/core/foreach.py |
Document this module using docstrings |
from __future__ import annotations
from collections.abc import Iterator
from hashlib import md5
from typing import Any, ClassVar, Literal
from reflex.components.el.element import Element
from reflex.components.tags.tag import Tag
from reflex.constants import Dirs, EventTriggers
from reflex.event import (
FORM_DA... | --- +++ @@ -1,3 +1,4 @@+"""Forms classes."""
from __future__ import annotations
@@ -36,6 +37,18 @@ on_submit_event_chain: str,
reset_on_submit: str,
) -> str:
+ """Generate handle submit JS using f-string formatting.
+
+ Args:
+ handle_submit_unique_name: Unique name for the handle submit fu... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/el/elements/forms.py |
Fully document this Python code with docstrings |
from typing import Literal
import reflex as rx
from reflex.components.component import Component, ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.lucide.icon import Icon
from reflex.components.radix.themes.base import Litera... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -13,6 +14,7 @@
class CalloutRoot(elements.Div, RadixThemesComponent):
+ """Groups Icon and Text parts of a Callout."""
tag = "Callout.Root"
@@ -33,16 +35,19 @@
class CalloutIcon(elem... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/callout.py |
Add minimal docstrings for each function |
from typing import Literal
from reflex.components.component import Component, ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import (
LiteralAccentColor,
LiteralSpacing,
RadixThemesComponent,
)
from reflex.components.radix.themes.layou... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -18,6 +19,7 @@
class Checkbox(RadixThemesComponent):
+ """Selects a single value, typically for submission in a form."""
tag = "Checkbox"
@@ -62,6 +64,7 @@
class HighLevelCheckbox(Ra... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/checkbox.py |
Add docstrings to improve code quality |
from reflex.components.base.fragment import Fragment
from reflex.components.component import Component
from reflex.vars.base import Var
class AppWrap(Fragment):
@classmethod
def create(cls) -> Component:
return super().create(Var(_js_expr="children")) | --- +++ @@ -1,3 +1,4 @@+"""Top-level component that wraps the entire app."""
from reflex.components.base.fragment import Fragment
from reflex.components.component import Component
@@ -5,7 +6,13 @@
class AppWrap(Fragment):
+ """Top-level component that wraps the entire app."""
@classmethod
def cre... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/base/app_wrap.py |
Write reusable docstrings |
from typing import Any, Literal
from reflex import Component, ComponentNamespace
from reflex.components.el.elements.inline import ReferrerPolicy
from reflex.constants.colors import Color
from reflex.vars.base import Var
from .base import BaseHTML
class Area(BaseHTML):
tag = "area"
# Alternate text for th... | --- +++ @@ -1,3 +1,4 @@+"""Media classes."""
from typing import Any, Literal
@@ -10,6 +11,7 @@
class Area(BaseHTML):
+ """Display the area element."""
tag = "area"
@@ -48,6 +50,7 @@
class Audio(BaseHTML):
+ """Display the audio element."""
tag = "audio"
@@ -78,6 +81,7 @@
class I... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/el/elements/media.py |
Document all public functions with docstrings |
from typing import Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import (
RadixThemesComponent,
RadixThemesTriggerComponent,
)
from reflex.constants... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -14,6 +15,7 @@
class HoverCardRoot(RadixThemesComponent):
+ """For sighted users to preview content available behind a link."""
tag = "HoverCard.Root"
@@ -34,6 +36,7 @@
class HoverCa... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/hover_card.py |
Write docstrings for algorithm functions |
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import RadixThemesComponent
from reflex.vars.base import Var
LiteralButtonSize = Literal["1", "2", "3", "4"]
class Inset(elements.Div, RadixThemesC... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -10,6 +11,7 @@
class Inset(elements.Div, RadixThemesComponent):
+ """Applies a negative margin to allow content to bleed into the surrounding container."""
tag = "Inset"
@@ -41,4 +43,4 @... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/inset.py |
Fill in missing docstrings in my code |
from __future__ import annotations
import dataclasses
from collections.abc import Mapping, Sequence
from enum import Enum
from typing import Any, Literal, TypedDict
from reflex.components.component import Component, NoSSRComponent
from reflex.components.literals import LiteralRowMarker
from reflex.event import Event... | --- +++ @@ -1,3 +1,4 @@+"""Data Editor component from glide-data-grid."""
from __future__ import annotations
@@ -20,6 +21,7 @@
# TODO: Fix the serialization issue for custom types.
class GridColumnIcons(Enum):
+ """An Enum for the available icons in DataEditor."""
Array = "array"
AudioUri = "audi... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/datadisplay/dataeditor.py |
Improve my code by adding docstrings |
from __future__ import annotations
from collections.abc import Sequence
from typing import Any, Literal
from reflex.components.component import Component, ComponentNamespace
from reflex.components.radix.primitives.base import RadixPrimitiveComponentWithClassName
from reflex.event import EventHandler, passthrough_eve... | --- +++ @@ -1,3 +1,4 @@+"""Radix slider components."""
from __future__ import annotations
@@ -14,11 +15,13 @@
class SliderComponent(RadixPrimitiveComponentWithClassName):
+ """Base class for all @radix-ui/react-slider components."""
library = "@radix-ui/react-slider@1.3.6"
class SliderRoot(Slide... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/primitives/slider.py |
Create documentation strings for testing functions |
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import RadixThemesComponent
from reflex.vars.base import Var
class Card(elements.Div, RadixThemesComponent):
tag = "Card"
# Change the def... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -8,6 +9,7 @@
class Card(elements.Div, RadixThemesComponent):
+ """Container that groups related content and actions."""
tag = "Card"
@@ -21,4 +23,4 @@ variant: Var[Literal["surface",... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/card.py |
Create simple docstrings for beginners |
from typing import Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import (
RadixThemesComponent,
RadixThemesTriggerComponent,
)
from reflex.constants... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -14,6 +15,7 @@
class DialogRoot(RadixThemesComponent):
+ """Root component for Dialog."""
tag = "Dialog.Root"
@@ -28,6 +30,7 @@
class DialogTrigger(RadixThemesTriggerComponent):
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/dialog.py |
Generate docstrings for exported functions |
from typing import Literal
from reflex.components.component import Component
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.style import Style
from reflex.vars.base import Var
class Progress(RadixThemesCo... | --- +++ @@ -1,3 +1,4 @@+"""Progress from Radix Themes."""
from typing import Literal
@@ -9,6 +10,7 @@
class Progress(RadixThemesComponent):
+ """A progress bar component."""
tag = "Progress"
@@ -41,10 +43,27 @@
@staticmethod
def _color_selector(color: str) -> Style:
+ """Return a ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/progress.py |
Write docstrings describing each step |
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.vars.base import LiteralVar, Var
LiteralSeparatorSize = Literal["1", "2", "3", "4"]
class Separator(RadixThemesComponent):
t... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -9,6 +10,7 @@
class Separator(RadixThemesComponent):
+ """Visually or semantically separates content."""
tag = "Separator"
@@ -26,4 +28,4 @@
# Alias to divider.
-divider = separator ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/separator.py |
Expand my code with proper documentation strings |
import textwrap
from typing import Any, cast
from reflex.components.base import Fragment
from reflex.components.component import BaseComponent, Component, MemoizationLeaf, field
from reflex.components.tags import Tag
from reflex.components.tags.match_tag import MatchTag
from reflex.style import Style
from reflex.util... | --- +++ @@ -1,3 +1,4 @@+"""rx.match."""
import textwrap
from typing import Any, cast
@@ -15,6 +16,7 @@
class Match(MemoizationLeaf):
+ """Match cases based on a condition."""
# The condition to determine which case to match.
cond: Var[Any]
@@ -31,6 +33,18 @@
@classmethod
def create(cls... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/core/match.py |
Write proper docstrings for these functions |
from typing import ClassVar, Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import (
LiteralAccentColor,
RadixThemesComponent,
RadixThemesTriggerComponent,
)
from reflex.constants.compile... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import ClassVar, Literal
@@ -29,6 +30,7 @@
class DropdownMenuRoot(RadixThemesComponent):
+ """The Dropdown Menu Root Component."""
tag = "DropdownMenu.Root"
@@ -51,6 +53,7 @@
class DropdownMenuTrigger... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/dropdown_menu.py |
Add detailed docstrings explaining each function |
from types import SimpleNamespace
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.vars.base import Var
class CheckboxCardsRoot(RadixThemesComponent):
tag = "CheckboxCards.Ro... | --- +++ @@ -1,3 +1,4 @@+"""Components for the Radix CheckboxCards component."""
from types import SimpleNamespace
from typing import Literal
@@ -8,6 +9,7 @@
class CheckboxCardsRoot(RadixThemesComponent):
+ """Root element for a CheckboxCards component."""
tag = "CheckboxCards.Root"
@@ -31,14 +33,16 ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/checkbox_cards.py |
Generate docstrings for this script |
from typing import Any
from reflex.components.component import Component
from reflex.components.tags.tag import Tag
from reflex.utils import format
from reflex.vars.base import Var
class RadixPrimitiveComponent(Component):
# Change the default rendered element for the one passed as a child.
as_child: Var[b... | --- +++ @@ -1,3 +1,4 @@+"""The base component for Radix primitives."""
from typing import Any
@@ -8,12 +9,14 @@
class RadixPrimitiveComponent(Component):
+ """Basic component for radix Primitives."""
# Change the default rendered element for the one passed as a child.
as_child: Var[bool]
cl... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/primitives/base.py |
Create simple docstrings for beginners |
from __future__ import annotations
from typing import Literal
from reflex.components.component import Component
from reflex.components.core.breakpoints import Responsive
from reflex.components.core.match import Match
from reflex.components.el import elements
from reflex.components.lucide import Icon
from reflex.comp... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from __future__ import annotations
@@ -24,6 +25,7 @@
class IconButton(elements.Button, RadixLoadingProp, RadixThemesComponent):
+ """A button designed specifically for usage with a single icon."""
tag = "IconButton"
... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/icon_button.py |
Write docstrings describing functionality |
from __future__ import annotations
import dataclasses
import re
from collections import defaultdict
from dataclasses import dataclass
from typing import Any, Literal
from reflex.components.component import Component, ComponentNamespace, field
from reflex.components.core.colors import color
from reflex.components.cor... | --- +++ @@ -1,3 +1,4 @@+"""Shiki syntax hghlighter component."""
from __future__ import annotations
@@ -25,6 +26,11 @@
def copy_script() -> Any:
+ """Copy script for the code block and modify the child SVG element.
+
+ Returns:
+ Any: The result of calling the script.
+ """
return run_scri... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/datadisplay/shiki_code_block.py |
Generate missing documentation strings |
from collections.abc import Sequence
from typing import ClassVar, Literal
import reflex as rx
from reflex.components.component import Component, ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import (
LiteralAccentColor,
LiteralRadius,
... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from collections.abc import Sequence
from typing import ClassVar, Literal
@@ -16,6 +17,7 @@
class SelectRoot(RadixThemesComponent):
+ """Displays a list of options for the user to pick from, triggered by a button."""
ta... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/select.py |
Add docstrings for production code |
# Based on Vaul: https://github.com/emilkowalski/vaul
# Style based on https://ui.shadcn.com/docs/components/drawer
from __future__ import annotations
from collections.abc import Sequence
from typing import Any, Literal
from reflex.components.component import Component, ComponentNamespace
from reflex.components.radi... | --- +++ @@ -1,3 +1,4 @@+"""Drawer components based on Radix primitives."""
# Based on Vaul: https://github.com/emilkowalski/vaul
# Style based on https://ui.shadcn.com/docs/components/drawer
@@ -16,6 +17,7 @@
class DrawerComponent(RadixPrimitiveComponent):
+ """A Drawer component."""
library = "vaul@1... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/primitives/drawer.py |
Write docstrings for backend logic |
from __future__ import annotations
from collections.abc import Sequence
from typing import Literal
from reflex.components.component import Component
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.event imp... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from __future__ import annotations
@@ -18,6 +19,7 @@
class Slider(RadixThemesComponent):
+ """Provides user selection from a range of values."""
tag = "Slider"
@@ -81,6 +83,15 @@ *children,
**props,
... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/slider.py |
Create docstrings for each class method |
from reflex.components.radix.themes.layout.box import Box
# Add responsive styles shortcuts.
def mobile_only(*children, **props):
return Box.create(*children, **props, display=["block", "none", "none", "none"])
def tablet_only(*children, **props):
return Box.create(*children, **props, display=["none", "blo... | --- +++ @@ -1,23 +1,69 @@+"""Responsive components."""
from reflex.components.radix.themes.layout.box import Box
# Add responsive styles shortcuts.
def mobile_only(*children, **props):
+ """Create a component that is only visible on mobile.
+
+ Args:
+ *children: The children to pass to the compon... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/core/responsive.py |
Add clean documentation to messy code |
from typing import Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import (
RadixThemesComponent,
RadixThemesTriggerComponent,
)
from reflex.constants... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -14,6 +15,7 @@
class PopoverRoot(RadixThemesComponent):
+ """Floating element for displaying rich content, triggered by a button."""
tag = "Popover.Root"
@@ -31,6 +33,7 @@
class Popo... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/popover.py |
Add docstrings to improve readability |
import reflex as rx
SVG_COLOR = rx.color_mode_cond("#110F1F", "white")
def svg_logo(color: str | rx.Var[str] = SVG_COLOR, **props):
def logo_path(d: str):
return rx.el.path(d=d)
paths = [
"M0 11.5999V0.399902H8.96V4.8799H6.72V2.6399H2.24V4.8799H6.72V7.1199H2.24V11.5999H0ZM6.72 11.5999V7.11... | --- +++ @@ -1,3 +1,4 @@+"""A Reflex logo component."""
import reflex as rx
@@ -5,6 +6,15 @@
def svg_logo(color: str | rx.Var[str] = SVG_COLOR, **props):
+ """A Reflex logo SVG.
+
+ Args:
+ color: The color of the logo.
+ props: Extra props to pass to the svg component.
+
+ Returns:
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/datadisplay/logo.py |
Improve my code by adding docstrings |
from __future__ import annotations
from typing import Any, ClassVar, Literal
from reflex.components.component import Component, ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.core.colors import color
from reflex.components.radix.themes.base import LiteralAccentCol... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from __future__ import annotations
@@ -15,6 +16,7 @@
class TabsRoot(RadixThemesComponent):
+ """Set of content sections to be displayed one at a time."""
tag = "Tabs.Root"
@@ -40,6 +42,11 @@ on_change: EventHandl... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/tabs.py |
Create docstrings for each class method |
from typing import Literal
from reflex.components.component import Component
from reflex.components.radix.themes.base import RadixThemesComponent
from reflex.constants.compiler import MemoizationMode
from reflex.event import EventHandler, no_args_event_spec, passthrough_event_spec
from reflex.utils import format
from... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -32,6 +33,7 @@
# The Tooltip inherits props from the Tooltip.Root, Tooltip.Portal, Tooltip.Content
class Tooltip(RadixThemesComponent):
+ """Floating element that provides a control with contextua... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/tooltip.py |
Create documentation strings for testing functions |
from typing import ClassVar, Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import CommonPaddingProps, RadixThemesComponent
from reflex.vars.base import Var
... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import ClassVar, Literal
@@ -9,6 +10,7 @@
class TableRoot(elements.Table, RadixThemesComponent):
+ """A semantic table for presenting tabular data."""
tag = "Table.Root"
@@ -20,6 +22,7 @@
class TableH... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/table.py |
Help me document legacy Python code |
from __future__ import annotations
from typing import Literal
from reflex.components.component import Component, ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.core.debounce import DebounceInput
from reflex.components.el import elements
from reflex.components.radi... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from __future__ import annotations
@@ -22,6 +23,7 @@
class TextFieldRoot(elements.Input, RadixThemesComponent):
+ """Captures user input with an optional slot for buttons and icons."""
tag = "TextField.Root"
@@ -90,6... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/text_field.py |
Provide clean and structured docstrings |
from __future__ import annotations
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import (
CommonMarginProps,
CommonPaddingProps,
RadixThemesComponent,
)
from reflex.vars.base import Var
LiteralBoolNumber = Literal["0", "1"]
... | --- +++ @@ -1,3 +1,4 @@+"""Declarative layout and common spacing props."""
from __future__ import annotations
@@ -15,9 +16,13 @@
class LayoutComponent(CommonMarginProps, CommonPaddingProps, RadixThemesComponent):
+ """Box, Flex and Grid are foundational elements you'll use to construct
+ layouts. Box pro... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/layout/base.py |
Create docstrings for each class method |
from typing import Literal
from reflex.components.component import Component
from reflex.components.core.breakpoints import Responsive
from reflex.components.core.debounce import DebounceInput
from reflex.components.el import elements
from reflex.components.radix.themes.base import (
LiteralAccentColor,
Liter... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -18,6 +19,7 @@
class TextArea(RadixThemesComponent, elements.Textarea):
+ """The input part of a TextArea, may be used by itself."""
tag = "TextArea"
@@ -83,12 +85,26 @@
@classmeth... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/text_area.py |
Add docstrings to existing functions |
from __future__ import annotations
from typing import ClassVar, Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import (
LiteralAlign,
LiteralJustify,
LiteralSpacing,
RadixThemesComponent,
)
from refl... | --- +++ @@ -1,3 +1,4 @@+"""Declarative layout and common spacing props."""
from __future__ import annotations
@@ -17,6 +18,7 @@
class Grid(elements.Div, RadixThemesComponent):
+ """Component for creating grid layouts."""
tag = "Grid"
@@ -55,4 +57,4 @@ }
-grid = Grid.create+grid = Grid.creat... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/layout/grid.py |
Generate consistent documentation across files |
from __future__ import annotations
from reflex.components.el import elements
from reflex.components.radix.themes.base import RadixThemesComponent
class Box(elements.Div, RadixThemesComponent):
tag = "Box"
box = Box.create | --- +++ @@ -1,3 +1,4 @@+"""Declarative layout and common spacing props."""
from __future__ import annotations
@@ -6,8 +7,9 @@
class Box(elements.Div, RadixThemesComponent):
+ """A fundamental layout building block, based on `div` element."""
tag = "Box"
-box = Box.create+box = Box.create
| https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/layout/box.py |
Generate docstrings for each module |
from __future__ import annotations
from typing import TYPE_CHECKING, Any, TypedDict, TypeVar
from reflex.components.component import Component, NoSSRComponent
from reflex.components.core.cond import color_mode_cond
from reflex.event import EventHandler, no_args_event_spec
from reflex.utils import console
from reflex... | --- +++ @@ -1,3 +1,4 @@+"""Component for displaying a plotly graph."""
from __future__ import annotations
@@ -22,6 +23,14 @@
def _event_points_data_signature(e0: Var) -> tuple[Var[list[Point]]]:
+ """For plotly events with event data containing a point array.
+
+ Args:
+ e0: The event data.
+
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/plotly/plotly.py |
Document this script properly |
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.event import EventHandler, passthrough_event_spec
from reflex.vars.base import Var
LiteralSwitchSize = Literal["1", "2", "3"]
cla... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -10,6 +11,7 @@
class Switch(RadixThemesComponent):
+ """A toggle switch alternative to the checkbox."""
tag = "Switch"
@@ -56,4 +58,4 @@ on_change: EventHandler[passthrough_event_spe... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/switch.py |
Document this module using docstrings |
from __future__ import annotations
from typing import ClassVar, Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import (
LiteralAlign,
LiteralJustify,
LiteralSpacing,
RadixThemesComponent,
)
from refl... | --- +++ @@ -1,3 +1,4 @@+"""Declarative layout and common spacing props."""
from __future__ import annotations
@@ -18,6 +19,7 @@
class Flex(elements.Div, RadixThemesComponent):
+ """Component for creating flex layouts."""
tag = "Flex"
@@ -43,4 +45,4 @@ _rename_props: ClassVar[dict[str, str]] = {... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/layout/flex.py |
Create documentation for each function signature |
from __future__ import annotations
from collections.abc import Callable
from dataclasses import _MISSING_TYPE, MISSING
from typing import Any, TypeVar, get_args, get_origin
from typing_extensions import dataclass_transform
from reflex.components.field import BaseField, FieldBasedMeta
from reflex.event import EventC... | --- +++ @@ -1,3 +1,4 @@+"""A class that holds props to be passed or applied to a component."""
from __future__ import annotations
@@ -19,6 +20,14 @@
def _get_props_subclass(field_type: Any) -> type | None:
+ """Extract the Props subclass from a field type annotation.
+
+ Args:
+ field_type: The ty... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/props.py |
Generate docstrings for exported functions |
from __future__ import annotations
from typing import Any, Literal, get_args
from reflex.components.component import BaseComponent, field
from reflex.components.core.cond import Cond, color_mode_cond, cond
from reflex.components.lucide.icon import Icon
from reflex.components.radix.themes.components.dropdown_menu imp... | --- +++ @@ -1,3 +1,19 @@+"""A switch component for toggling color_mode.
+
+To style components based on color mode, use style props with `color_mode_cond`:
+
+```
+rx.text(
+ "Hover over me",
+ _hover={
+ "background": rx.color_mode_cond(
+ light="var(--accent-2)",
+ dark="var(--accen... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/color_mode.py |
Add standardized docstrings across the file |
from __future__ import annotations
from typing import Any, ClassVar, Literal
from reflex.components import Component
from reflex.components.core.breakpoints import Responsive
from reflex.components.tags import Tag
from reflex.utils.imports import ImportDict, ImportVar
from reflex.vars.base import Var
LiteralAlign =... | --- +++ @@ -1,3 +1,4 @@+"""Base classes for radix-themes components."""
from __future__ import annotations
@@ -49,6 +50,7 @@
class CommonMarginProps(Component):
+ """Many radix-themes elements accept shorthand margin props."""
# Margin: "0" - "9" # noqa: ERA001
m: Var[LiteralSpacing]
@@ -73,6 +7... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/base.py |
Add docstrings to meet PEP guidelines |
from __future__ import annotations
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import RadixThemesComponent
from reflex.vars.base import LiteralVar, Var
LiteralSectionSize = Literal["1", "2", "... | --- +++ @@ -1,3 +1,4 @@+"""Declarative layout and common spacing props."""
from __future__ import annotations
@@ -12,6 +13,7 @@
class Section(elements.Section, RadixThemesComponent):
+ """Denotes a section of page content."""
tag = "Section"
@@ -19,4 +21,4 @@ size: Var[Responsive[LiteralSection... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/layout/section.py |
Generate NumPy-style docstrings |
from __future__ import annotations
from collections.abc import Iterable
from typing import Any, Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.foreach import Foreach
from reflex.components.el.elements.base import BaseHTML
from reflex.components.el.elements.typography i... | --- +++ @@ -1,3 +1,4 @@+"""List components."""
from __future__ import annotations
@@ -39,6 +40,7 @@
class BaseList(BaseHTML, MarkdownComponentMap):
+ """Base class for ordered and unordered lists."""
tag = "ul"
@@ -56,6 +58,15 @@ *children,
**props,
):
+ """Create a lis... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/layout/list.py |
Document this module using docstrings |
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import (
LiteralAccentColor,
LiteralRadius,
RadixThemesComponent,
)
from reflex.vars.base import Var
LiteralSize = Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"]
class Ava... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -13,6 +14,7 @@
class Avatar(RadixThemesComponent):
+ """An image element with a fallback for representing the user."""
tag = "Avatar"
@@ -38,4 +40,4 @@ fallback: Var[str]
-avatar... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/avatar.py |
Auto-generate documentation strings for this file |
from __future__ import annotations
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import RadixThemesComponent
from reflex.style import STACK_CHILDREN_FULL_WIDTH
from reflex.vars.base import Litera... | --- +++ @@ -1,3 +1,4 @@+"""Declarative layout and common spacing props."""
from __future__ import annotations
@@ -13,6 +14,10 @@
class Container(elements.Div, RadixThemesComponent):
+ """Constrains the maximum width of page content.
+
+ See https://www.radix-ui.com/themes/docs/components/container
+ "... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/layout/container.py |
Write docstrings describing functionality |
from __future__ import annotations
from typing import Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.markdown.markdown import MarkdownComponentMap
from reflex.components.radi... | --- +++ @@ -1,3 +1,7 @@+"""Components for rendering text.
+
+https://www.radix-ui.com/themes/docs/theme/typography
+"""
from __future__ import annotations
@@ -35,6 +39,7 @@
class Text(elements.Span, RadixThemesComponent, MarkdownComponentMap):
+ """A foundational text primitive based on the <span> element."... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/typography/text.py |
Add docstrings that explain inputs and outputs |
from __future__ import annotations
from typing import Literal
from reflex.components.component import Component, MemoizationLeaf
from reflex.components.core.breakpoints import Responsive
from reflex.components.core.colors import color
from reflex.components.core.cond import cond
from reflex.components.el.elements.in... | --- +++ @@ -1,3 +1,7 @@+"""Components for rendering heading.
+
+https://www.radix-ui.com/themes/docs/theme/typography
+"""
from __future__ import annotations
@@ -23,6 +27,7 @@
class Link(RadixThemesComponent, A, MemoizationLeaf, MarkdownComponentMap):
+ """A semantic element for navigation between pages."""... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/typography/link.py |
Document functions with clear intent |
from __future__ import annotations
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.markdown.markdown import MarkdownComponentMap
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.vars.base imp... | --- +++ @@ -1,3 +1,7 @@+"""Components for rendering heading.
+
+https://www.radix-ui.com/themes/docs/theme/typography
+"""
from __future__ import annotations
@@ -11,6 +15,7 @@
class Heading(elements.H1, RadixThemesComponent, MarkdownComponentMap):
+ """A foundational text primitive based on the <span> eleme... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/typography/heading.py |
Document functions with clear intent |
from __future__ import annotations
from typing import Any, TypedDict
from reflex.components.component import Component
from reflex.components.core.cond import cond
from reflex.event import EventHandler, no_args_event_spec
from reflex.utils import console
from reflex.vars.base import Var
from reflex.vars.object impor... | --- +++ @@ -1,3 +1,4 @@+"""React-Player component."""
from __future__ import annotations
@@ -14,6 +15,7 @@
class Progress(TypedDict):
+ """Callback containing played and loaded progress as a fraction, and playedSeconds and loadedSeconds in seconds."""
played: float
playedSeconds: float
@@ -23,6 ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/react_player/react_player.py |
Document all endpoints with docstrings |
from typing import Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import (
RadixThemesComponent,
RadixThemesTriggerComponent,
)
from reflex.constants... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -16,6 +17,7 @@
class AlertDialogRoot(RadixThemesComponent):
+ """Contains all the parts of the dialog."""
tag = "AlertDialog.Root"
@@ -30,6 +32,7 @@
class AlertDialogTrigger(RadixThe... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/alert_dialog.py |
Fully document this Python code with docstrings |
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import (
LiteralAccentColor,
LiteralRadius,
LiteralVariant,
RadixLoadingProp,
RadixThemesComponent,
)
from reflex.vars.base import... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -16,6 +17,7 @@
class Button(elements.Button, RadixLoadingProp, RadixThemesComponent):
+ """Trigger an action or event, such as submitting a form or displaying a dialog."""
tag = "Button"
... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/button.py |
Help me write clear docstrings |
from __future__ import annotations
from collections.abc import Sequence
from typing import Any, ClassVar
from reflex.components.component import Component
from reflex.components.recharts.general import ResponsiveContainer
from reflex.constants import EventTriggers
from reflex.constants.colors import Color
from refle... | --- +++ @@ -1,3 +1,4 @@+"""A module that defines the chart components in Recharts."""
from __future__ import annotations
@@ -22,6 +23,7 @@
class ChartBase(RechartsCharts):
+ """A component that wraps a Recharts charts."""
# The width of chart container. String or Integer
width: Var[str | int] = ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/recharts/charts.py |
Add docstrings for utility scripts |
from __future__ import annotations
from collections.abc import Sequence
from typing import Any, ClassVar
from reflex.constants import EventTriggers
from reflex.constants.colors import Color
from reflex.event import EventHandler, no_args_event_spec
from reflex.vars.base import LiteralVar, Var
from .recharts import (... | --- +++ @@ -1,3 +1,4 @@+"""Polar charts in Recharts."""
from __future__ import annotations
@@ -22,6 +23,7 @@
class Pie(Recharts):
+ """A Pie chart component in Recharts."""
tag = "Pie"
@@ -95,6 +97,11 @@
@classmethod
def get_event_triggers(cls) -> dict[str, Var | Any]:
+ """Get th... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/recharts/polar.py |
Write docstrings that follow conventions |
from types import SimpleNamespace
from typing import ClassVar, Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.event import EventHandler, passthrough_event_spec
from reflex.vars.base import Var
cla... | --- +++ @@ -1,3 +1,4 @@+"""Radio component from Radix Themes."""
from types import SimpleNamespace
from typing import ClassVar, Literal
@@ -9,6 +10,7 @@
class RadioCardsRoot(RadixThemesComponent):
+ """Root element for RadioCards component."""
tag = "RadioCards.Root"
@@ -62,6 +64,7 @@
class Radi... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/radio_cards.py |
Help me comply with documentation standards |
from reflex.components.radix.themes.base import RadixThemesComponent
from reflex.vars.base import Var
class AspectRatio(RadixThemesComponent):
tag = "AspectRatio"
# The ratio of the width to the height of the element
ratio: Var[float | int]
aspect_ratio = AspectRatio.create | --- +++ @@ -1,9 +1,11 @@+"""Interactive components provided by @radix-ui/themes."""
from reflex.components.radix.themes.base import RadixThemesComponent
from reflex.vars.base import Var
class AspectRatio(RadixThemesComponent):
+ """Displays content with a desired ratio."""
tag = "AspectRatio"
@@ -1... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/aspect_ratio.py |
Write beginner-friendly docstrings |
from __future__ import annotations
from collections.abc import Sequence
from typing import Any, ClassVar, TypedDict
from reflex.constants import EventTriggers
from reflex.constants.colors import Color
from reflex.event import EventHandler, no_args_event_spec
from reflex.vars.base import LiteralVar, Var
from .rechar... | --- +++ @@ -1,3 +1,4 @@+"""Cartesian charts in Recharts."""
from __future__ import annotations
@@ -32,6 +33,7 @@
class Axis(Recharts):
+ """A base class for axes in Recharts."""
# The key of data displayed in the axis.
data_key: Var[str | int]
@@ -131,6 +133,7 @@
class XAxis(Axis):
+ """A... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/recharts/cartesian.py |
Write docstrings for this repository |
from __future__ import annotations
from collections.abc import Sequence
from typing import Any, ClassVar
from reflex.components.component import MemoizationLeaf
from reflex.constants.colors import Color
from reflex.event import EventHandler, no_args_event_spec
from reflex.vars.base import LiteralVar, Var
from .rech... | --- +++ @@ -1,3 +1,4 @@+"""General components for Recharts."""
from __future__ import annotations
@@ -21,6 +22,7 @@
class ResponsiveContainer(Recharts, MemoizationLeaf):
+ """A base class for responsive containers in Recharts."""
tag = "ResponsiveContainer"
@@ -64,6 +66,7 @@
class Legend(Rechar... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/recharts/general.py |
Write docstrings for algorithm functions |
import dataclasses
from reflex.components.tags import Tag
from reflex.utils import format
@dataclasses.dataclass(frozen=True, kw_only=True)
class Tagless(Tag):
# The inner contents of the tag.
contents: str
def __str__(self) -> str:
out = self.contents
space = format.wrap(" ", "{")
... | --- +++ @@ -1,3 +1,4 @@+"""A tag with no tag."""
import dataclasses
@@ -7,11 +8,17 @@
@dataclasses.dataclass(frozen=True, kw_only=True)
class Tagless(Tag):
+ """A tag with no tag."""
# The inner contents of the tag.
contents: str
def __str__(self) -> str:
+ """Return the string repr... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/tags/tagless.py |
Turn comments into proper docstrings |
from __future__ import annotations
from collections.abc import Sequence
from typing import Literal
import reflex as rx
from reflex.components.component import Component, ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import (
LiteralAccentCol... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from __future__ import annotations
@@ -23,6 +24,7 @@
class RadioGroupRoot(RadixThemesComponent):
+ """A set of interactive radio buttons where only one can be selected at a time."""
tag = "RadioGroup.Root"
@@ -61,6 +... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/radio_group.py |
Add missing documentation to my Python functions |
from collections.abc import Sequence
from types import SimpleNamespace
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.vars.base import Var
class CheckboxGroupRoot(RadixThemesCom... | --- +++ @@ -1,3 +1,4 @@+"""Components for the CheckboxGroup component of Radix Themes."""
from collections.abc import Sequence
from types import SimpleNamespace
@@ -9,6 +10,7 @@
class CheckboxGroupRoot(RadixThemesComponent):
+ """Root element for a CheckboxGroup component."""
tag = "CheckboxGroup.Root... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/checkbox_group.py |
Add docstrings that explain purpose and usage |
from __future__ import annotations
from collections.abc import Sequence
from types import SimpleNamespace
from typing import ClassVar, Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.event import Ev... | --- +++ @@ -1,3 +1,4 @@+"""SegmentedControl from Radix Themes."""
from __future__ import annotations
@@ -14,10 +15,19 @@ def on_value_change(
value: Var[str | list[str]],
) -> tuple[Var[str | list[str]]]:
+ """Handle the on_value_change event.
+
+ Args:
+ value: The value of the event.
+
+ Re... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/segmented_control.py |
Document my Python code with docstrings |
from __future__ import annotations
from typing import ClassVar, Literal, TypedDict
from reflex.components.el.elements.inline import A
from reflex.vars.base import Var
LiteralLinkDiscover = Literal["none", "render"]
class To(TypedDict):
# A URL pathname, beginning with a /
pathname: str
# A URL searc... | --- +++ @@ -1,3 +1,4 @@+"""Components for client side navigation within React Router applications."""
from __future__ import annotations
@@ -10,6 +11,7 @@
class To(TypedDict):
+ """Structured object for navigating via the `to` prop."""
# A URL pathname, beginning with a /
pathname: str
@@ -22,6 ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/react_router/dom.py |
Add docstrings that explain logic |
from __future__ import annotations
import platform
from enum import Enum
from importlib import metadata
from pathlib import Path
from types import SimpleNamespace
from typing import Literal
from platformdirs import PlatformDirs
IS_WINDOWS = platform.system() == "Windows"
IS_MACOS = platform.system() == "Darwin"
IS_... | --- +++ @@ -1,3 +1,4 @@+"""Base file for constants that don't fit any other categories."""
from __future__ import annotations
@@ -16,6 +17,7 @@
class Dirs(SimpleNamespace):
+ """Various directories/paths used by Reflex."""
# The frontend directories in a project.
# The web folder where the front... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/constants/base.py |
Create Google-style docstrings for my code |
from typing import Literal
from reflex.components.radix.themes.base import RadixThemesComponent
from reflex.vars.base import Var
class ScrollArea(RadixThemesComponent):
tag = "ScrollArea"
# The alignment of the scroll area
scrollbars: Var[Literal["vertical", "horizontal", "both"]]
# Describes the... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import Literal
@@ -6,6 +7,7 @@
class ScrollArea(RadixThemesComponent):
+ """Custom styled, cross-browser scrollable area using native functionality."""
tag = "ScrollArea"
@@ -19,4 +21,4 @@ scroll_hide... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/scroll_area.py |
Improve documentation using docstrings |
import dataclasses
import importlib
import os
import sys
import threading
import urllib.parse
from collections.abc import Sequence
from importlib.util import find_spec
from pathlib import Path
from types import ModuleType
from typing import TYPE_CHECKING, Annotated, Any, ClassVar, Literal
from reflex import constants... | --- +++ @@ -1,3 +1,4 @@+"""The Reflex config."""
import dataclasses
import importlib
@@ -35,6 +36,7 @@
@dataclasses.dataclass(kw_only=True)
class DBConfig:
+ """Database config."""
engine: str
username: str | None = ""
@@ -52,6 +54,18 @@ host: str | None = None,
port: int | None =... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/config.py |
Write docstrings for this repository |
from typing import Any, Literal
from reflex.components.component import Component, MemoizationLeaf, NoSSRComponent
class Recharts(Component):
library = "recharts@3.7.0"
def _get_style(self) -> dict:
return {"wrapperStyle": self.style}
class RechartsCharts(NoSSRComponent, MemoizationLeaf):
l... | --- +++ @@ -1,3 +1,4 @@+"""A component that wraps a recharts lib."""
from typing import Any, Literal
@@ -5,6 +6,7 @@
class Recharts(Component):
+ """A component that wraps a recharts lib."""
library = "recharts@3.7.0"
@@ -13,6 +15,7 @@
class RechartsCharts(NoSSRComponent, MemoizationLeaf):
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/recharts/recharts.py |
Create docstrings for reusable components |
from __future__ import annotations
import os
import re
import subprocess
import sys
from collections import namedtuple
from contextlib import contextmanager
from pathlib import Path
from typing import Any
import click
from reflex import constants
from reflex.constants import CustomComponents
from reflex.utils impor... | --- +++ @@ -1,3 +1,4 @@+"""CLI for creating custom components."""
from __future__ import annotations
@@ -20,6 +21,16 @@ def _pyproject_toml_template(
package_name: str, module_name: str, reflex_version: str
) -> str:
+ """Template for custom components pyproject.toml.
+
+ Args:
+ package_name: T... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/custom_components/custom_components.py |
Write docstrings describing functionality |
from __future__ import annotations
import dataclasses
from collections.abc import Iterator, Mapping, Sequence
from typing import Any
from reflex.event import EventChain
from reflex.utils import format
from reflex.vars.base import LiteralVar, Var
def render_prop(value: Any) -> Any:
from reflex.components.compon... | --- +++ @@ -1,3 +1,4 @@+"""A React tag."""
from __future__ import annotations
@@ -11,6 +12,14 @@
def render_prop(value: Any) -> Any:
+ """Render the prop.
+
+ Args:
+ value: The value to render.
+
+ Returns:
+ The rendered value.
+ """
from reflex.components.component import Base... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/tags/tag.py |
Add concise docstrings to each method |
import re
from types import SimpleNamespace
class RouteArgType(SimpleNamespace):
SINGLE = "arg_single"
LIST = "arg_list"
# the name of the backend var containing path and client information
ROUTER = "router"
ROUTER_DATA = "router_data"
class RouteVar(SimpleNamespace):
CLIENT_IP = "ip"
CLIENT_TO... | --- +++ @@ -1,9 +1,11 @@+"""Route constants."""
import re
from types import SimpleNamespace
class RouteArgType(SimpleNamespace):
+ """Type of dynamic route arg extracted from URI route."""
SINGLE = "arg_single"
LIST = "arg_list"
@@ -15,6 +17,7 @@
class RouteVar(SimpleNamespace):
+ """Name... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/constants/route.py |
Write docstrings for data processing functions |
from typing import ClassVar, Literal
from reflex.components.component import ComponentNamespace
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.constants.compiler import MemoizationMode
from reflex.event imp... | --- +++ @@ -1,3 +1,4 @@+"""Interactive components provided by @radix-ui/themes."""
from typing import ClassVar, Literal
@@ -28,6 +29,7 @@
class ContextMenuRoot(RadixThemesComponent):
+ """Menu representing a set of actions, displayed at the origin of a pointer right-click or long-press."""
tag = "Con... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/context_menu.py |
Add docstrings that explain inputs and outputs |
from __future__ import annotations
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.vars.base import Var
from .base import LiteralTextSize, LiteralTextWeight
class... | --- +++ @@ -1,3 +1,7 @@+"""Components for rendering heading.
+
+https://www.radix-ui.com/themes/docs/theme/typography
+"""
from __future__ import annotations
@@ -10,6 +14,7 @@
class Blockquote(elements.Blockquote, RadixThemesComponent):
+ """A block level extended quotation."""
tag = "Blockquote"
@... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/typography/blockquote.py |
Add clean documentation to messy code |
from __future__ import annotations
import os
from types import SimpleNamespace
from .base import IS_WINDOWS
from .utils import classproperty
# Bun config.
class Bun(SimpleNamespace):
# The Bun version.
VERSION = "1.3.9"
# Min Bun Version
MIN_VERSION = "1.3.0"
# URL to bun install script.
... | --- +++ @@ -1,3 +1,4 @@+"""File for constants related to the installation process. (Bun/Node)."""
from __future__ import annotations
@@ -10,6 +11,7 @@
# Bun config.
class Bun(SimpleNamespace):
+ """Bun constants."""
# The Bun version.
VERSION = "1.3.9"
@@ -31,6 +33,11 @@ @classproperty
@... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/constants/installer.py |
Add docstrings for internal functions |
from collections.abc import Callable
from typing import Any, Generic, TypeVar
T = TypeVar("T")
V = TypeVar("V")
class classproperty(Generic[T, V]):
def __init__(self, getter: Callable[[type[T]], V]) -> None:
self.getter = getattr(getter, "__func__", getter)
def __get__(self, instance: Any, owner: ... | --- +++ @@ -1,3 +1,4 @@+"""Utility functions for constants."""
from collections.abc import Callable
from typing import Any, Generic, TypeVar
@@ -7,9 +8,24 @@
class classproperty(Generic[T, V]):
+ """A class property decorator."""
def __init__(self, getter: Callable[[type[T]], V]) -> None:
+ """... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/constants/utils.py |
Generate docstrings for each module |
from types import SimpleNamespace
from typing import Literal
from reflex.components.core.breakpoints import Responsive
from reflex.components.radix.themes.base import LiteralAccentColor, RadixThemesComponent
from reflex.vars.base import Var
class DataListRoot(RadixThemesComponent):
tag = "DataList.Root"
#... | --- +++ @@ -1,3 +1,4 @@+"""Components for the DataList component of Radix Themes."""
from types import SimpleNamespace
from typing import Literal
@@ -8,6 +9,7 @@
class DataListRoot(RadixThemesComponent):
+ """Root element for a DataList component."""
tag = "DataList.Root"
@@ -22,6 +24,7 @@
class... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/components/data_list.py |
Add docstrings explaining edge cases |
from __future__ import annotations
import concurrent.futures
import dataclasses
import enum
import importlib
import multiprocessing
import os
import platform
from collections.abc import Callable, Sequence
from functools import lru_cache
from pathlib import Path
from typing import (
TYPE_CHECKING,
Annotated,
... | --- +++ @@ -1,3 +1,4 @@+"""Environment variable management."""
from __future__ import annotations
@@ -31,6 +32,17 @@
def get_default_value_for_field(field: dataclasses.Field) -> Any:
+ """Get the default value for a field.
+
+ Args:
+ field: The field.
+
+ Returns:
+ The default value.
+... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/environment.py |
Add inline docstrings for readability |
from enum import Enum
from types import SimpleNamespace
class Endpoint(Enum):
PING = "ping"
EVENT = "_event"
UPLOAD = "_upload"
AUTH_CODESPACE = "auth-codespace"
HEALTH = "_health"
ALL_ROUTES = "_all_routes"
def __str__(self) -> str:
return f"/{self.value}"
def get_url(self... | --- +++ @@ -1,9 +1,11 @@+"""Event-related constants."""
from enum import Enum
from types import SimpleNamespace
class Endpoint(Enum):
+ """Endpoints for the reflex backend API."""
PING = "ping"
EVENT = "_event"
@@ -13,9 +15,19 @@ ALL_ROUTES = "_all_routes"
def __str__(self) -> str:
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/constants/event.py |
Annotate my code with docstrings |
import asyncio
import contextlib
import dataclasses
from collections.abc import AsyncIterator
from typing_extensions import Unpack, override
from reflex.istate.manager import StateManager, StateModificationContext
from reflex.state import BaseState, _split_substate_key
@dataclasses.dataclass
class StateManagerMemo... | --- +++ @@ -1,3 +1,4 @@+"""A state manager that stores states in memory."""
import asyncio
import contextlib
@@ -12,6 +13,7 @@
@dataclasses.dataclass
class StateManagerMemory(StateManager):
+ """A state manager that stores states in memory."""
# The mapping of client ids to states.
states: dict[st... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/istate/manager/memory.py |
Provide clean and structured docstrings |
from typing import Any
from reflex.istate.proxy import ReadOnlyStateProxy
from reflex.state import _split_substate_key, _substate_key, get_state_manager
async def get_state(token: str, state_cls: Any | None = None) -> ReadOnlyStateProxy:
mng = get_state_manager()
if state_cls is not None:
root_state... | --- +++ @@ -1,3 +1,4 @@+"""Wrappers for the state manager."""
from typing import Any
@@ -6,6 +7,15 @@
async def get_state(token: str, state_cls: Any | None = None) -> ReadOnlyStateProxy:
+ """Get the instance of a state for a token.
+
+ Args:
+ token: The token for the state.
+ state_cls: T... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/istate/wrappers.py |
Add structured docstrings to improve clarity |
import dataclasses
from collections.abc import Iterator, Mapping
from typing import Any
from reflex.components.tags.tag import Tag
@dataclasses.dataclass(frozen=True, kw_only=True)
class CondTag(Tag):
# The condition to determine which component to render.
cond_state: str
# The code to render if the c... | --- +++ @@ -1,3 +1,4 @@+"""Tag to conditionally render components."""
import dataclasses
from collections.abc import Iterator, Mapping
@@ -8,6 +9,7 @@
@dataclasses.dataclass(frozen=True, kw_only=True)
class CondTag(Tag):
+ """A conditional tag."""
# The condition to determine which component to render.... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/tags/cond_tag.py |
Turn comments into proper docstrings |
from __future__ import annotations
from typing import Any
from reflex.utils import format
class ClientStorageBase:
def options(self) -> dict[str, Any]:
return {
format.to_camel_case(k): v for k, v in vars(self).items() if v is not None
}
class Cookie(ClientStorageBase, str):
... | --- +++ @@ -1,3 +1,4 @@+"""Client-side storage classes for reflex state variables."""
from __future__ import annotations
@@ -7,14 +8,21 @@
class ClientStorageBase:
+ """Base class for client-side storage."""
def options(self) -> dict[str, Any]:
+ """Get the options for the storage.
+
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/istate/storage.py |
Write clean docstrings for readability |
import asyncio
import contextlib
import dataclasses
import inspect
import os
import sys
import time
import uuid
from collections.abc import AsyncIterator
from typing import TypedDict
from redis import ResponseError
from redis.asyncio import Redis
from typing_extensions import Unpack, override
from reflex.config impo... | --- +++ @@ -1,3 +1,4 @@+"""A state manager that stores states in redis."""
import asyncio
import contextlib
@@ -32,14 +33,29 @@
def _default_lock_expiration() -> int:
+ """Get the default lock expiration time.
+
+ Returns:
+ The default lock expiration time.
+ """
return get_config().redis_... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/istate/manager/redis.py |
Create Google-style docstrings for my code |
from __future__ import annotations
import dataclasses
from typing import Any, Literal
from reflex.components.component import Component, ComponentNamespace
from reflex.components.lucide.icon import Icon
from reflex.components.props import NoExtrasAllowedProps
from reflex.constants.base import Dirs
from reflex.event ... | --- +++ @@ -1,3 +1,4 @@+"""Sonner toast component."""
from __future__ import annotations
@@ -36,6 +37,7 @@
@dataclasses.dataclass
class ToastAction:
+ """A toast action that render a button in the toast."""
label: str
on_click: Any
@@ -43,6 +45,14 @@
@serializer
def serialize_action(action: To... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/sonner/toast.py |
Add return value explanations in docstrings |
from __future__ import annotations
from reflex.components.core.breakpoints import Responsive
from reflex.components.el import elements
from reflex.components.markdown.markdown import MarkdownComponentMap
from reflex.components.radix.themes.base import (
LiteralAccentColor,
LiteralVariant,
RadixThemesCompo... | --- +++ @@ -1,3 +1,7 @@+"""Components for rendering heading.
+
+https://www.radix-ui.com/themes/docs/theme/typography
+"""
from __future__ import annotations
@@ -15,6 +19,7 @@
class Code(elements.Code, RadixThemesComponent, MarkdownComponentMap):
+ """A block level extended quotation."""
tag = "Code"... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/radix/themes/typography/code.py |
Document this script properly |
import contextlib
import dataclasses
from abc import ABC, abstractmethod
from collections.abc import AsyncIterator
from typing import TypedDict
from typing_extensions import ReadOnly, Unpack
from reflex import constants
from reflex.config import get_config
from reflex.event import Event
from reflex.state import Base... | --- +++ @@ -1,3 +1,4 @@+"""State manager for managing client states."""
import contextlib
import dataclasses
@@ -16,6 +17,7 @@
class StateModificationContext(TypedDict, total=False):
+ """The context for modifying state."""
event: ReadOnly[Event]
@@ -25,12 +27,24 @@
@dataclasses.dataclass
class S... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/istate/manager/__init__.py |
Generate docstrings for script automation |
import datetime
from collections.abc import Sequence
from pathlib import Path
from types import SimpleNamespace
from typing import TYPE_CHECKING, Literal, TypedDict
from xml.etree.ElementTree import Element, SubElement, indent, tostring
from typing_extensions import NotRequired
from reflex import constants
from .ba... | --- +++ @@ -1,3 +1,4 @@+"""Sitemap plugin for Reflex."""
import datetime
from collections.abc import Sequence
@@ -24,6 +25,7 @@
class SitemapLink(TypedDict):
+ """A link in the sitemap."""
loc: Location
lastmod: NotRequired[LastModified]
@@ -32,6 +34,7 @@
class SitemapLinkConfiguration(TypedD... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/plugins/sitemap.py |
Add docstrings to improve collaboration |
import dataclasses
from collections.abc import Mapping
from copy import deepcopy
from typing import Any, Literal, TypedDict
from typing_extensions import NotRequired, Unpack
from .base import Plugin as PluginBase
TailwindPluginImport = TypedDict(
"TailwindPluginImport",
{
"name": str,
"from"... | --- +++ @@ -1,3 +1,4 @@+"""Tailwind CSS configuration types for Reflex plugins."""
import dataclasses
from collections.abc import Mapping
@@ -40,6 +41,14 @@
def remove_version_from_plugin(plugin: TailwindPluginConfig) -> TailwindPluginConfig:
+ """Remove the version from a plugin name.
+
+ Args:
+ ... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/plugins/shared_tailwind.py |
Improve documentation using docstrings |
from __future__ import annotations
from typing import TYPE_CHECKING, Any
if TYPE_CHECKING:
from reflex.vars import Var
class ReflexError(Exception):
class ConfigError(ReflexError):
class InvalidStateManagerModeError(ReflexError, ValueError):
class ReflexRuntimeError(ReflexError, RuntimeError):
class Up... | --- +++ @@ -1,3 +1,4 @@+"""Custom Exceptions."""
from __future__ import annotations
@@ -8,29 +9,43 @@
class ReflexError(Exception):
+ """Base exception for all Reflex exceptions."""
class ConfigError(ReflexError):
+ """Custom exception for config related errors."""
class InvalidStateManagerMode... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/utils/exceptions.py |
Add docstrings for production code |
from __future__ import annotations
from pathlib import Path
from types import SimpleNamespace
class CustomComponents(SimpleNamespace):
# The name of the custom components source directory.
SRC_DIR = Path("custom_components")
# The name of the custom components pyproject.toml file.
PYPROJECT_TOML = ... | --- +++ @@ -1,3 +1,4 @@+"""Constants for the custom components."""
from __future__ import annotations
@@ -6,6 +7,7 @@
class CustomComponents(SimpleNamespace):
+ """Constants for the custom components."""
# The name of the custom components source directory.
SRC_DIR = Path("custom_components")
@@... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/constants/custom_components.py |
Add minimal docstrings for each function |
from __future__ import annotations
import dataclasses
import inspect
from collections.abc import Callable, Iterable
from typing import TYPE_CHECKING
from reflex.components.tags.tag import Tag
from reflex.utils.types import GenericType
from reflex.vars import LiteralArrayVar, Var, get_unique_variable_name
from reflex... | --- +++ @@ -1,3 +1,4 @@+"""Tag to loop through a list of components."""
from __future__ import annotations
@@ -17,6 +18,7 @@
@dataclasses.dataclass(frozen=True)
class IterTag(Tag):
+ """An iterator tag."""
# The var to iterate over.
iterable: Var[Iterable] = dataclasses.field(
@@ -33,21 +35,49 @@... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/tags/iter_tag.py |
Create documentation for each function signature |
import dataclasses
from collections.abc import Iterator, Mapping, Sequence
from typing import Any
from reflex.components.tags.tag import Tag
@dataclasses.dataclass(frozen=True, kw_only=True)
class MatchTag(Tag):
# The condition to determine which case to match.
cond: str
# The list of match cases to b... | --- +++ @@ -1,3 +1,4 @@+"""Tag to conditionally match cases."""
import dataclasses
from collections.abc import Iterator, Mapping, Sequence
@@ -8,6 +9,7 @@
@dataclasses.dataclass(frozen=True, kw_only=True)
class MatchTag(Tag):
+ """A match tag."""
# The condition to determine which case to match.
c... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/components/tags/match_tag.py |
Help me comply with documentation standards |
import dataclasses
import enum
from enum import Enum
from types import SimpleNamespace
from reflex.constants import Dirs
from reflex.utils.imports import ImportVar
# The prefix used to create setters for state vars.
SETTER_PREFIX = "set_"
# The file used to specify no compilation.
NOCOMPILE_FILE = "nocompile"
cla... | --- +++ @@ -1,3 +1,4 @@+"""Compiler variables."""
import dataclasses
import enum
@@ -15,6 +16,7 @@
class Ext(SimpleNamespace):
+ """Extension used in Reflex."""
# The extension for JS files.
JS = ".js"
@@ -33,6 +35,7 @@
class CompileVars(SimpleNamespace):
+ """The variables used during com... | https://raw.githubusercontent.com/reflex-dev/reflex/HEAD/reflex/constants/compiler.py |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.