Skip to content
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.

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

Add section on JSON operators in ipython-sql magics to Troubleshooting #43

Merged
merged 2 commits into from
May 21, 2021
Merged
Changes from 1 commit
Commits
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
10 changes: 10 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ OCDS Kingfisher Colab |release|
Troubleshooting
---------------

Using Jupyter Notebook
^^^^^^^^^^^^^^^^^^^^^^

If you are using Kingfisher Colab in a Jupyter Notebook (not on Google Colaboratory), you need to:

#. Install the ``google-colab`` package:
Expand All @@ -25,6 +28,13 @@ If you are using Kingfisher Colab in a Jupyter Notebook (not on Google Colaborat

pip install --upgrade ipykernel

Using JSON operators with ipython-sql magics
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

When using the ipython-sql magics (``%sql`` or ``%%sql``), you must avoid spaces around JSON operators.
Bjwebb marked this conversation as resolved.
Show resolved Hide resolved

E.g. ``data->'ocid'`` not ``data -> 'ocid'``

API
---

Expand Down