Skip to content

Commit

Permalink
Update doc to indicate that python filter's add_dimension accepts arr…
Browse files Browse the repository at this point in the history
…ay. (#2103)

* Update doc to indicate that python filter's add_dimension accepts array.

* Update python filter's doc to indicate add_dimension also accepts single arg.
  • Loading branch information
dzleidig authored and abellgithub committed Jul 24, 2018
1 parent 97f02ca commit adcd360
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions doc/stages/filters.python.rst
Expand Up @@ -44,8 +44,19 @@ filter and the ``outs`` array represents the points after filtering.



2) If you want to write a dimension that might not be available, use can use one
or more ``add_dimension`` options.
2) If you want write a dimension that might not be available, you can specify
it with the ``add_dimension`` option.

.. code-block:: json
"add_dimension": "NewDimensionOne"
To create more than one dimension, this option also accepts an array.

.. code-block:: json
"add_dimension": [ "NewDimensionOne", "NewDimensionTwo", "NewDimensionThree" ]
.. note::

Expand Down Expand Up @@ -265,7 +276,7 @@ source
The literal `Python`_ code to execute, when the script option is not being used.

add_dimension
The name of a dimension to add to the pipeline that does not already exist.
A dimension name or an array of dimension names to add to the pipeline that do not already exist.

pdalargs
A JSON dictionary of items you wish to pass into the modules globals as the
Expand Down

0 comments on commit adcd360

Please sign in to comment.