Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
gadenbuie committed Jan 26, 2024
1 parent c50fb2c commit 9e53f64
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions shiny/_docstring.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,10 @@ def add_example(
``__name__`` matches the name of directory under a ``api-examples/`` directory in
the current or any parent directory.
* Examples for the ``shiny`` package are in ``shiny/api-examples/``.
* Examples for the ``shiny.express`` subpackage are in ``shiny/express/api-examples/``.
* Examples for the ``shiny`` package are in ``shiny/api-examples/``. We also place
Express examples in this directory adjacent to their Core counterparts.
* Examples for the ``shiny.experimental`` subpackage are in
``shiny/experimental/api-examples/``.
Functions that can be used in Express or Core and whose canonical implementation is
in the ``shiny`` package should have examples in ``shiny/api-examples``. In this
Expand Down

0 comments on commit 9e53f64

Please sign in to comment.