Skip to content

Commit

Permalink
Set valid GMT data mode as GMT_IS_OUTPUT
Browse files Browse the repository at this point in the history
Should be GMT_IS_OUTPUT instead of GMT_OUTPUT. Also update some docstrings that were missed in the #210 refactor PR.
  • Loading branch information
weiji14 committed Jun 22, 2020
1 parent 522ceba commit d203cd5
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions pygmt/clib/session.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"GMT_IS_SURFACE",
]

MODES = ["GMT_CONTAINER_ONLY", "GMT_OUTPUT"]
MODES = ["GMT_CONTAINER_ONLY", "GMT_IS_OUTPUT"]

REGISTRATIONS = ["GMT_GRID_PIXEL_REG", "GMT_GRID_NODE_REG"]

Expand Down Expand Up @@ -509,13 +509,13 @@ def create_data(self, family, geometry, mode, **kwargs):
----------
family : str
A valid GMT data family name (e.g., ``'GMT_IS_DATASET'``). See the
``data_families`` attribute for valid names.
``FAMILIES`` attribute for valid names.
geometry : str
A valid GMT data geometry name (e.g., ``'GMT_IS_POINT'``). See the
``data_geometries`` attribute for valid names.
``GEOMETRIES`` attribute for valid names.
mode : str
A valid GMT data mode (e.g., ``'GMT_OUTPUT'``). See the
``data_modes`` attribute for valid names.
A valid GMT data mode (e.g., ``'GMT_IS_OUTPUT'``). See the
``MODES`` attribute for valid names.
dim : list of 4 integers
The dimensions of the dataset. See the documentation for the GMT C
API function ``GMT_Create_Data`` (``src/gmt_api.c``) for the full
Expand Down Expand Up @@ -843,12 +843,12 @@ def write_data(self, family, geometry, mode, wesn, output, data):
----------
family : str
A valid GMT data family name (e.g., ``'GMT_IS_DATASET'``). See the
``data_families`` attribute for valid names. Don't use the
``FAMILIES`` attribute for valid names. Don't use the
``GMT_VIA_VECTOR`` or ``GMT_VIA_MATRIX`` constructs for this. Use
``GMT_IS_VECTOR`` and ``GMT_IS_MATRIX`` instead.
geometry : str
A valid GMT data geometry name (e.g., ``'GMT_IS_POINT'``). See the
``data_geometries`` attribute for valid names.
``GEOMETRIES`` attribute for valid names.
mode : str
How the data is to be written to the file. This option varies
depending on the given family. See the GMT API documentation for
Expand Down

0 comments on commit d203cd5

Please sign in to comment.