Merge pull request #43 from open-contracting/json-operators-spaces

Add section on JSON operators in ipython-sql magics to Troubleshooting
open-contracting · May 21, 2021 · b989f9f · b989f9f
2 parents a135aeb + 11c4109
commit b989f9f
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -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:
@@ -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 the %sql magic
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When using the ipython-sql ``%sql`` line magic, you must avoid spaces around JSON operators.
+
+E.g. ``data->'ocid'`` not ``data -> 'ocid'``
+
 API
 ---