Skip to content

Commit

Permalink
docs: explain the limitation of IPython magic dict arguments (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
plamut committed Jun 4, 2020
1 parent 1e773f7 commit cfaa901
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions google/cloud/bigquery/magics.py
Expand Up @@ -65,6 +65,14 @@
serializable. The variable reference is indicated by a ``$`` before
the variable name (ex. ``$my_dict_var``). See ``In[6]`` and ``In[7]``
in the Examples section below.
.. note::
Due to the way IPython argument parser works, negative numbers in
dictionaries are incorrectly "recognized" as additional arguments,
resulting in an error ("unrecognized arguments"). To get around this,
pass such dictionary as a JSON string variable.
* ``<query>`` (required, cell argument):
SQL query to run. If the query does not contain any whitespace (aside
from leading and trailing whitespace), it is assumed to represent a
Expand Down

0 comments on commit cfaa901

Please sign in to comment.