Skip to content

Commit 6033d27

Browse files
committed
docstring and changelog
1 parent 5945c7a commit 6033d27

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

docs/source/about/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Unreleased
2222
- :pull:`1113` - Added ``standard``, ``uvicorn``, ``jinja`` installation extras (for example ``pip install reactpy[standard]``).
2323
- :pull:`1113` - Added support for Python 3.12 and 3.13.
2424
- :pull:`1264` - Added ``reactpy.use_async_effect`` hook.
25+
- :pull:`1267` - Added ``shutdown_timeout`` parameter to the ``reactpy.use_async_effect`` hook.
2526

2627
**Changed**
2728

src/reactpy/core/hooks.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,12 @@ def use_effect(
120120
function: _SyncEffectFunc | None = None,
121121
dependencies: Sequence[Any] | ellipsis | None = ...,
122122
) -> Callable[[_SyncEffectFunc], None] | None:
123-
"""See the full :ref:`Use Effect` docs for details
123+
"""
124+
A hook that manages an synchronous side effect in a React-like component.
125+
126+
This hook allows you to run a synchronous function as a side effect and
127+
ensures that the effect is properly cleaned up when the component is
128+
re-rendered or unmounted.
124129
125130
Parameters:
126131
function:

0 commit comments

Comments
 (0)