Skip to content

Commit

Permalink
docs: clarify %%bigquery` magics and fix broken link (#508)
Browse files Browse the repository at this point in the history
  • Loading branch information
tswast authored Feb 16, 2021
1 parent 9902789 commit eedf93b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Integrations with Other Libraries

pandas

See also, the :mod:`google.cloud.bigquery.magics` module for integrations
with Jupyter.
See also, the :mod:`google.cloud.bigquery.magics.magics` module for
integrations with Jupyter.


9 changes: 9 additions & 0 deletions google/cloud/bigquery/magics/magics.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@

"""IPython Magics
To use these magics, you must first register them. Run the ``%load_ext`` magic
in a Jupyter notebook cell.
.. code::
%load_ext google.cloud.bigquery
This makes the ``%%bigquery`` magic available.
.. function:: %%bigquery
IPython cell magic to run a query and display the result as a DataFrame
Expand Down

0 comments on commit eedf93b

Please sign in to comment.