Skip to content

Commit b971f0d

Browse files
committed
Improve the documentation
1 parent 9fbe5ac commit b971f0d

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

doc/techref/array_dtypes.md

+15-12
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,34 @@
11
# Supported Array Dtypes
22

3-
This page documents array dtypes supported by PyGMT.
3+
PyGMT uses NumPy arrays to store data and passes them to the GMT C library. In this way,
4+
PyGMT can support a wide range of dtypes. This page documents array dtypes supported by
5+
PyGMT.
46

57
## Numeric Dtypes
68

7-
PyGMT supports most numeric dtypes provided by NumPy, pandas and PyArrow, including the following:
9+
For 1-D and 2-D arrays, PyGMT supports most numeric dtypes provided by NumPy, pandas, and
10+
PyArrow.
811

912
**Signed Integers:**
1013

11-
- :class:`numpy.int8`, :class:`numpy.int16`, :class:`numpy.int32`, :class:`numpy.int64`
12-
- :class:`pandas.Int8`, :class:`pandas.Int16`, :class:`pandas.Int32`, :class:`pandas.Int64`
13-
- :class:`pyarrow.int8`, :class:`pyarrow.int16`, :class:`pyarrow.int32`, :class:`pyarrow.int64`
14+
- {class}`numpy.int8`, {class}`numpy.int16`, {class}`numpy.int32`, {class}`numpy.int64`
15+
- {class}`pandas.Int8`, {class}`pandas.Int16`, {class}`pandas.Int32`, {class}`pandas.Int64`
16+
- {class}`pyarrow.int8`, {class}`pyarrow.int16`, {class}`pyarrow.int32`, {class}`pyarrow.int64`
1417

1518
**Unsigned Integers:**
1619

17-
- :class:`numpy.uint8`, :class:`numpy.uint16`, :class:`numpy.uint32`, :class:`numpy.uint64`
18-
- :class:`pandas.UInt8`, :class:`pandas.UInt16`, :class:`pandas.UInt32`, :class:`pandas.UInt64`
19-
- :class:`pyarrow.uint8`, :class:`pyarrow.uint16`, :class:`pyarrow.uint32`, :class:`pyarrow.uint64`
20+
- {class}`numpy.uint8`, {class}`numpy.uint16`, {class}`numpy.uint32`, {class}`numpy.uint64`
21+
- {class}`pandas.UInt8`, {class}`pandas.UInt16`, {class}`pandas.UInt32`, {class}`pandas.UInt64`
22+
- {class}`pyarrow.uint8`, {class}`pyarrow.uint16`, {class}`pyarrow.uint32`, {class}`pyarrow.uint64`
2023

2124
**Floating-point numbers:**
2225

23-
- :class:`numpy.float32`, :class:`numpy.float64`
24-
- :class:`pandas.Float32`, :class:`pandas.Float64`
25-
- :class:`pyarrow.float32`, :class:`pyarrow.float64`
26+
- {class}`numpy.float32`, {class}`numpy.float64`
27+
- {class}`pandas.Float32`, {class}`pandas.Float64`
28+
- {class}`pyarrow.float32`, {class}`pyarrow.float64`
2629

2730
For raster images, only 8-bit unsigned intergers (i.e., :class:``)) are supported.
2831

2932
## String Dtypes
3033

31-
## Datetime Dtypes
34+
## Datetime Dtypes

0 commit comments

Comments
 (0)