Skip to content

Added %magic? to docs #625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 19, 2023
Merged

Added %magic? to docs #625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fced0c9
Added help commands
mehtamohit013 Jun 19, 2023
8b91fad
Changelog
mehtamohit013 Jun 19, 2023
72af473
Changelog
mehtamohit013 Jun 19, 2023
2934c83
Merge branch 'master' into help
mehtamohit013 Jun 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 4 additions & 0 deletions doc/api/magic-plot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`


Expand Down
4 changes: 4 additions & 0 deletions doc/api/magic-profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions doc/api/magic-render.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
4 changes: 4 additions & 0 deletions doc/api/magic-sql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))

Expand Down
2 changes: 1 addition & 1 deletion doc/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?`.
```


Expand Down