diff --git a/CHANGELOG.md b/CHANGELOG.md index 872691394..f2f10153a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,8 @@ * [Doc] Added more details to the SQL parametrization user guide. ([#288](https://github.com/ploomber/jupysql/issues/288)) * [Doc] Snowflake integration guide ([#384](https://github.com/ploomber/jupysql/issues/384)) * [Doc] User guide on using JupySQL in `.py` scripts ([#449](https://github.com/ploomber/jupysql/issues/449)) +* [Doc] Added `%magic?` to APIs and quickstart ([#97](https://github.com/ploomber/jupysql/issues/97)) + ## 0.7.8 (2023-06-01) diff --git a/doc/api/magic-plot.md b/doc/api/magic-plot.md index 2d85b2c06..0d6a92d04 100644 --- a/doc/api/magic-plot.md +++ b/doc/api/magic-plot.md @@ -52,6 +52,10 @@ if not Path("penguins.csv").is_file(): SELECT * FROM "penguins.csv" LIMIT 3 ``` +```{note} +You can view the documentation and command line arguments by running `%sqlplot?` +``` + ## `%sqlplot boxplot` diff --git a/doc/api/magic-profile.md b/doc/api/magic-profile.md index dcd309b63..efb074deb 100644 --- a/doc/api/magic-profile.md +++ b/doc/api/magic-profile.md @@ -21,6 +21,10 @@ myst: `%sqlcmd profile` allows you to obtain summary statistics of a table quickly. The code used here is compatible with all major databases. +```{note} +You can view the documentation and command line arguments by running `%sqlcmd?` +``` + Arguments: `-t`/`--table` (Required) Get the profile of a table diff --git a/doc/api/magic-render.md b/doc/api/magic-render.md index 09bac8b2d..d2dbca53d 100644 --- a/doc/api/magic-render.md +++ b/doc/api/magic-render.md @@ -24,6 +24,10 @@ myst: `%sqlrender` helps you compose large SQL queries. +```{note} +You can view the documentation and command line arguments by running `%sqlrender?` +``` + ```{code-cell} ipython3 %load_ext sql ``` diff --git a/doc/api/magic-sql.md b/doc/api/magic-sql.md index 333df4fcd..a0a6ba548 100644 --- a/doc/api/magic-sql.md +++ b/doc/api/magic-sql.md @@ -19,6 +19,10 @@ myst: # `%sql`/`%%sql` +```{note} +You can view the documentation and command line arguments by running `%sql?` +``` + ``-l`` / ``--connections`` List all active connections ([example](#list-connections)) diff --git a/doc/quick-start.md b/doc/quick-start.md index c3b3612df..b88bf8af9 100644 --- a/doc/quick-start.md +++ b/doc/quick-start.md @@ -50,7 +50,7 @@ conda install jupysql -c conda-forge ## Setup ```{tip} -If you are unfamiliar with Jupyter magics, you can refer to our [FAQ](user-guide/FAQ.md#what-is-a-magic) +If you are unfamiliar with Jupyter magics, you can refer to our [FAQ](user-guide/FAQ.md#what-is-a-magic). Also, you can view the documentation and command line arguments of any magic command by running `%magic?` like `%sql?` or `%sqlplot?`. ```