Skip to content

Commit

Permalink
review doc
Browse files Browse the repository at this point in the history
  • Loading branch information
floriankrb committed Apr 9, 2024
1 parent 95a1e63 commit 13a68eb
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/using/methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ metadata()
provenance()
Return the dataset's provenance information.

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

tree():
tree()
For debugging. Return the dataset's internal tree structure.

************
Expand Down
10 changes: 10 additions & 0 deletions docs/using/subsetting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Subsetting is the action of filtering the dataset by its first dimension
*******

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

.. literalinclude:: code/start_.py

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

Note that the ``start="2020"`` is equivalent to ``start="2020-01-01"``
while ``end="2020"`` is equivalent to ``end="2020-12-31"``.

Note also how the ``frequency`` of the dataset will change how the
``end`` option is interpreted: - ``end="2020"`` with a ``frequency`` of
one hour is equivalent to ``end="2020-12-31 23:00"`` - ``end="2020"``
with a ``frequency`` of 6 hours is equivalent to ``end="2020-12-31
18:00"``

.. _frequency:

***********
Expand Down

0 comments on commit 13a68eb

Please sign in to comment.