Skip to content

Commit ce25235

Browse files
committed
README
1 parent a328f1e commit ce25235

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.org

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1341,8 +1341,7 @@ SYNOPSIS
13411341
#+BEGIN_SRC python
13421342
# A baseline plot_options dict was given to us. We want to make the
13431343
# plot, but make sure to omit the legend key
1344-
1345-
add_plot_option(plot_options, 'unset', 'key')
1344+
gp.add_plot_option(plot_options, 'unset', 'key')
13461345

13471346
gp.plot(..., **plot_options)
13481347
#+END_SRC
@@ -1374,6 +1373,27 @@ an exception, or append to the existing list, as appropriate.
13741373
If the given key supports multiple values, they can be given in a single
13751374
call, as a list or a tuple.
13761375

1376+
Multiple key/values can be given using keyword arguments.
1377+
1378+
ARGUMENTS
1379+
1380+
- d: the plot options dict we're updating
1381+
1382+
- key: string. The key being set
1383+
1384+
- values: string (if setting a single value) or iterable (if setting multiple
1385+
values)
1386+
1387+
- **kwargs: more key/value pairs to set. We set the key/value positional
1388+
arguments first, and then move on to the kwargs
1389+
1390+
- overwrite: optional boolean that controls how we handle overwriting keys that
1391+
do not accept multiple values. By default (overwrite is None), trying to set a
1392+
key that is already set results in an exception. elif overwrite: we overwrite
1393+
the previous values. elif not overwrite: we leave the previous value
1394+
1395+
1396+
13771397
* COMPATIBILITY
13781398

13791399
Python 2 and Python 3 should both be supported. Please report a bug if either

0 commit comments

Comments
 (0)