Skip to content

Commit d66c028

Browse files
committed
update doc
1 parent 429e159 commit d66c028

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

docs/using/methods.rst

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,30 +35,32 @@ tree():
3535
shape:
3636
A tuple of the dataset's dimensions.
3737

38-
dtype:
39-
The dataset's data type.
40-
4138
field_shape:
42-
The dataset's field shape.
39+
The original shape of a single field, either 1D or 2D. When building
40+
datasets, the fields are flattened to 1D.
41+
42+
dtype:
43+
The dataset's `NumPy data type`_.
4344

4445
dates:
45-
The dataset's dates.
46+
The dataset's dates, as a NumPy vector of datetime64_ objects.
47+
48+
frequency:
49+
The dataset's frequency (i.e the delta between two consecutive dates)
50+
in hours.
4651

4752
latitudes:
48-
The dataset's latitudes.
53+
The dataset's latitudes as a NumPy vector.
4954

5055
longitudes:
51-
The dataset's longitudes.
56+
The dataset's longitudes as a NumPy vector.
5257

5358
statistics:
5459
The dataset's statistics.
5560

5661
resolution:
5762
The dataset's resolution.
5863

59-
frequency:
60-
The dataset's frequency.
61-
6264
name_to_index:
6365
A dictionary mapping variable names to their indices.
6466

@@ -70,3 +72,9 @@ missing:
7072

7173
grids:
7274
The dataset's grids.
75+
76+
.. _datetime64: https://docs.scipy.org/doc/numpy/reference/arrays.datetime.html
77+
78+
.. _numpy data type: https://docs.scipy.org/doc/numpy/user/basics.types.html
79+
80+
"""

0 commit comments

Comments
 (0)