Update return type formatting in docstrings

Author: wch

shiny/_validation.py

@@ -36,6 +36,7 @@ def req(*args: T, cancel_output: bool = False) -> T | None:
 
     Returns
     -------
+    :
         The first argument. If no arguments are provided, returns ``None``.
     """
     if len(args) == 0:

shiny/plotutils.py

@@ -75,6 +75,7 @@ def brushed_points(
 
     Returns
     -------
+    :
         A pandas DataFrame containing the rows selected by the brush. If `all_rows` is
         `True`, then all rows from the original data will be returned, along with an
         additional column named `selected_`, which indicates whether or not each row was
@@ -210,6 +211,7 @@ def near_points(
 
     Returns
     -------
+    :
         A pandas DataFrame containing the rows selected by the brush. If `all_rows` is
         `True`, then all rows from the original data will be returned, along with an
         additional column named `selected_`, which indicates whether or not each row was

shiny/reactive/_core.py

@@ -201,18 +201,19 @@ def isolate():
     Ordinarily, the simple act of reading a reactive value causes a relationship to be
     established between the caller and the reactive value, where a change to the
     reactive value will cause the caller to re-execute. (The same applies for the act of
-    getting a reactive expression's value.) `with isolate()` lets you read a
-    reactive value or expression without establishing this relationship.
+    getting a reactive expression's value.) `with isolate()` lets you read a reactive
+    value or expression without establishing this relationship.
 
-    ``with isolate()`` can also be useful for calling reactive expression at the console,
-    which can be useful for debugging. To do so, wrap the calls to the reactive
+    ``with isolate()`` can also be useful for calling reactive expression at the
+    console, which can be useful for debugging. To do so, wrap the calls to the reactive
     expression with ``with isolate()``.
 
     Returns
     -------
-    A context manager that executes the given expression in a scope where reactive
-    values can be read, but do not cause the reactive scope of the caller to be
-    re-evaluated when they change.
+    :
+        A context manager that executes the given expression in a scope where reactive
+        values can be read, but do not cause the reactive scope of the caller to be
+        re-evaluated when they change.
 
     See Also
     --------
@@ -228,7 +229,8 @@ def get_current_context() -> Context:
 
     Returns
     -------
-    A :class:`~Context`.
+    :
+        A :class:`~Context`.
 
     Raises
     ------
@@ -265,7 +267,8 @@ def on_flushed(
 
     Returns
     -------
-    A function that can be used to unregister the callback.
+    :
+        A function that can be used to unregister the callback.
 
     See Also
     --------

shiny/reactive/_poll.py

@@ -83,7 +83,8 @@ def poll(
 
     Returns
     -------
-    A decorator that should be applied to a no-argument function that (expensively)
+    :
+        A decorator that should be applied to a no-argument function that (expensively)
     reads whatever data is desired. (This function may be a regular function or a
     coroutine function.) The result of the decorator is a reactive ~shiny.reactive.Calc
     that always returns up-to-date data, and invalidates callers when changes are
@@ -256,7 +257,8 @@ def file_reader(
 
     Returns
     -------
-    A decorator that should be applied to a no-argument function that (expensively)
+    :
+        A decorator that should be applied to a no-argument function that (expensively)
     reads whatever data is desired. (This function may be a regular function or a
     coroutine function.) The result of the decorator is a reactive ~shiny.reactive.Calc
     that always returns up-to-date data, and invalidates callers when changes are

shiny/reactive/_reactives.py

@@ -59,7 +59,8 @@ class Value(Generic[T]):
 
     Returns
     -------
-    An instance of a reactive value.
+    :
+        An instance of a reactive value.
 
     Raises
     ------
@@ -114,7 +115,8 @@ def get(self) -> T:
 
         Returns
         -------
-        A value.
+        :
+            A value.
 
         Raises
         ------
@@ -142,7 +144,8 @@ def set(self, value: T) -> bool:
 
         Returns
         -------
-        ``True`` if the value was set to a different value and ``False`` otherwise.
+        :
+            ``True`` if the value was set to a different value and ``False`` otherwise.
 
         Raises
         ------
@@ -174,7 +177,8 @@ def unset(self) -> None:
 
         Returns
         -------
-        ``True`` if the value was set prior to this unsetting.
+        :
+            ``True`` if the value was set prior to this unsetting.
         """
         self.set(MISSING)  # type: ignore
 
@@ -184,7 +188,8 @@ def is_set(self) -> bool:
 
         Returns
         -------
-        ``True`` if the value is set, ``False`` otherwise.
+        :
+            ``True`` if the value is set, ``False`` otherwise.
         """
 
         self._is_set_dependents.register()
@@ -400,7 +405,8 @@ def Calc(
 
     Returns
     -------
-    A decorator that marks a function as a reactive calculation.
+    :
+        A decorator that marks a function as a reactive calculation.
 
     Tip
     ---
@@ -679,7 +685,8 @@ def Effect(
 
     Returns
     -------
-    A decorator that marks a function as a reactive effect (:class:`Effect_`).
+    :
+        A decorator that marks a function as a reactive effect (:class:`Effect_`).
 
     See Also
     --------
@@ -740,7 +747,8 @@ def event(
 
     Returns
     -------
-    A decorator that marks a function as an event handler.
+    :
+        A decorator that marks a function as an event handler.
 
     Tip
     ----

shiny/render/_render.py

@@ -148,7 +148,8 @@ def text(
 
     Returns
     -------
-    A decorator for a function that returns a string.
+    :
+        A decorator for a function that returns a string.
 
     Tip
     ----
@@ -329,7 +330,8 @@ def plot(
 
     Returns
     -------
-    A decorator for a function that returns any of the following:
+    :
+        A decorator for a function that returns any of the following:
 
         1. A :class:`matplotlib.figure.Figure` instance.
         2. An :class:`matplotlib.artist.Artist` instance.
@@ -453,7 +455,8 @@ def image(
 
     Returns
     -------
-    A decorator for a function that returns an `~shiny.types.ImgData` object.
+    :
+        A decorator for a function that returns an `~shiny.types.ImgData` object.
 
     Tip
     ----
@@ -628,7 +631,8 @@ def table(
 
     Returns
     -------
-    A decorator for a function that returns any of the following:
+    :
+        A decorator for a function that returns any of the following:
 
         1. A pandas :class:`DataFrame` object.
         2. A pandas :class:`Styler` object.
@@ -719,7 +723,8 @@ def ui(
 
     Returns
     -------
-    A decorator for a function that returns an object of type `~shiny.ui.TagChild`.
+    :
+        A decorator for a function that returns an object of type `~shiny.ui.TagChild`.
 
     Tip
     ----

shiny/session/_session.py

@@ -646,7 +646,8 @@ def on_flush(self, fn: Callable[[], None], once: bool = True) -> Callable[[], No
 
         Returns
         -------
-        A function that can be used to cancel the registration.
+        :
+            A function that can be used to cancel the registration.
         """
         return self._flush_callbacks.register(fn, once)
 
@@ -666,7 +667,8 @@ def on_flushed(
 
         Returns
         -------
-        A function that can be used to cancel the registration.
+        :
+            A function that can be used to cancel the registration.
         """
         return self._flushed_callbacks.register(fn, once)
 
@@ -717,7 +719,8 @@ def on_ended(self, fn: Callable[[], None]) -> Callable[[], None]:
 
         Returns
         -------
-        A function that can be used to cancel the registration.
+        :
+            A function that can be used to cancel the registration.
         """
         return self._on_ended_callbacks.register(fn)
 
@@ -752,7 +755,8 @@ def download(
 
         Returns
         -------
-        The decorated function.
+        :
+            The decorated function.
         """
 
         def wrapper(fn: DownloadHandler):
@@ -795,6 +799,7 @@ def dynamic_route(self, name: str, handler: DynamicRouteHandler) -> str:
 
         Returns
         -------
+        :
             The URL path for the route.
         """
 

shiny/session/_utils.py

@@ -34,7 +34,8 @@ def get_current_session() -> Optional[Session]:
 
     Returns
     -------
-    The current session if one is active, otherwise ``None``.
+    :
+        The current session if one is active, otherwise ``None``.
 
     Note
     ----
@@ -80,7 +81,8 @@ def require_active_session(session: Optional[Session]) -> Session:
 
     Returns
     -------
-    The session.
+    :
+        The session.
 
     Note
     ----