Skip to content

Commit 88eef3a

Browse files
committed
Set valid GMT data mode as GMT_IS_OUTPUT
Should be GMT_IS_OUTPUT instead of GMT_OUTPUT. Also update some docstrings that were missed in the #210 refactor PR.
1 parent 07b95ed commit 88eef3a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

pygmt/clib/session.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"GMT_IS_SURFACE",
4545
]
4646

47-
MODES = ["GMT_CONTAINER_ONLY", "GMT_OUTPUT"]
47+
MODES = ["GMT_CONTAINER_ONLY", "GMT_IS_OUTPUT"]
4848

4949
REGISTRATIONS = ["GMT_GRID_PIXEL_REG", "GMT_GRID_NODE_REG"]
5050

@@ -512,13 +512,13 @@ def create_data(self, family, geometry, mode, **kwargs):
512512
----------
513513
family : str
514514
A valid GMT data family name (e.g., ``'GMT_IS_DATASET'``). See the
515-
``data_families`` attribute for valid names.
515+
``FAMILIES`` attribute for valid names.
516516
geometry : str
517517
A valid GMT data geometry name (e.g., ``'GMT_IS_POINT'``). See the
518-
``data_geometries`` attribute for valid names.
518+
``GEOMETRIES`` attribute for valid names.
519519
mode : str
520-
A valid GMT data mode (e.g., ``'GMT_OUTPUT'``). See the
521-
``data_modes`` attribute for valid names.
520+
A valid GMT data mode (e.g., ``'GMT_IS_OUTPUT'``). See the
521+
``MODES`` attribute for valid names.
522522
dim : list of 4 integers
523523
The dimensions of the dataset. See the documentation for the GMT C
524524
API function ``GMT_Create_Data`` (``src/gmt_api.c``) for the full
@@ -903,12 +903,12 @@ def write_data(self, family, geometry, mode, wesn, output, data):
903903
----------
904904
family : str
905905
A valid GMT data family name (e.g., ``'GMT_IS_DATASET'``). See the
906-
``data_families`` attribute for valid names. Don't use the
906+
``FAMILIES`` attribute for valid names. Don't use the
907907
``GMT_VIA_VECTOR`` or ``GMT_VIA_MATRIX`` constructs for this. Use
908908
``GMT_IS_VECTOR`` and ``GMT_IS_MATRIX`` instead.
909909
geometry : str
910910
A valid GMT data geometry name (e.g., ``'GMT_IS_POINT'``). See the
911-
``data_geometries`` attribute for valid names.
911+
``GEOMETRIES`` attribute for valid names.
912912
mode : str
913913
How the data is to be written to the file. This option varies
914914
depending on the given family. See the GMT API documentation for

0 commit comments

Comments
 (0)