Skip to content

Commit 13a68eb

Browse files
committed
review doc
1 parent 95a1e63 commit 13a68eb

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/using/methods.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ metadata()
4242
provenance()
4343
Return the dataset's provenance information.
4444

45-
source(index):
45+
source(index)
4646
For debugging. Given the index of variable, this will return from
4747
which Zarr store it will be loaded. This is useful to debug combining
4848
datasets with :ref:`join`.
4949

50-
tree():
50+
tree()
5151
For debugging. Return the dataset's internal tree structure.
5252

5353
************

docs/using/subsetting.rst

+10
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Subsetting is the action of filtering the dataset by its first dimension
1414
*******
1515

1616
This option let you subset the dataset by time. You can pass a date or a
17+
string:
1718

1819
.. literalinclude:: code/start_.py
1920

@@ -34,6 +35,15 @@ The following are equivalent way of describing ``start`` or ``end``:
3435
- ``202306``, ``"202306"`` and ``"2023-06"``
3536
- ``20200301``, ``"20200301"`` and ``"2020-03-01"``
3637

38+
Note that the ``start="2020"`` is equivalent to ``start="2020-01-01"``
39+
while ``end="2020"`` is equivalent to ``end="2020-12-31"``.
40+
41+
Note also how the ``frequency`` of the dataset will change how the
42+
``end`` option is interpreted: - ``end="2020"`` with a ``frequency`` of
43+
one hour is equivalent to ``end="2020-12-31 23:00"`` - ``end="2020"``
44+
with a ``frequency`` of 6 hours is equivalent to ``end="2020-12-31
45+
18:00"``
46+
3747
.. _frequency:
3848

3949
***********

0 commit comments

Comments
 (0)