Skip to content

Commit 31ba8b5

Browse files
authored
Update documentation (#230)
1 parent 0a88f1f commit 31ba8b5

File tree

4 files changed

+1893
-815
lines changed

4 files changed

+1893
-815
lines changed

CHANGELOG.rst

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,37 @@ Changelog History
33
=================
44

55

6+
Intake-esm v2020.05.01
7+
======================
8+
9+
Features
10+
--------
11+
12+
- Add html representation for the catalog object. (:pr:`229`) `Anderson Banihirwe`_
13+
14+
- Move logic for assets aggregation into :py:meth:`~intake_esm.source.ESMGroupDataSource`
15+
and add few basic dict-like methods (keys(), __len__(), __getitem()__, __contains__())
16+
to the catalog object. (:pr:`194`) `Anderson Banihirwe`_ & `Joe Hamman`_ & `Kevin Paul`_
17+
18+
- Support columns with iterables in :py:meth:`~intake_esm.core.esm_datastore.unique` and
19+
:py:meth:`~intake_esm.core.esm_datastore.nunique`. (:pr:`223`) `Anderson Banihirwe`_
20+
21+
22+
Bug Fixes
23+
---------
24+
25+
- Revert back to using `concurrent.futures` to address failures due
26+
to dask's distributed scheduler. (:issue:`225`) & (:issue:`226`)
27+
28+
Internal
29+
--------
30+
31+
- Increase test coverage. (:pr:`222`) `Anderson Banihirwe`_
32+
33+
34+
635
Intake-esm v2020.03.16
7-
=======================
36+
======================
837

938

1039
Features
@@ -380,3 +409,4 @@ Trivial/Internal Changes
380409
.. _`Ryan Abernathey`: https://github.com/rabernat
381410
.. _`Julius Busecke`: https://github.com/jbusecke
382411
.. _`Joe Hamman`: https://github.com/jhamman
412+
.. _`Kevin Paul`: https://github.com/kmpaul

docs/source/api.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ This page provides an auto-generated summary of intake-esm’s API.
55
For more details and examples, refer to the relevant chapters in the main part of the documentation.
66

77

8-
ESM Datastore
9-
~~~~~~~~~~~~~
8+
ESM Datastore (intake.open_esm_datastore)
9+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1010

11-
.. autosummary::
11+
.. module:: intake_esm.core
1212

13-
intake_esm.core.esm_datastore
13+
.. autoclass:: esm_datastore
1414

15-
16-
.. autoclass:: intake_esm.core.esm_datastore
17-
:members:
15+
.. automethod:: __getitem__
16+
.. automethod:: from_df
17+
.. automethod:: to_dataset_dict
18+
.. automethod:: nunique
19+
.. automethod:: unique
20+
.. automethod:: search
21+
.. automethod:: serialize

0 commit comments

Comments
 (0)