Skip to content

Commit 507b9d4

Browse files
committed
more documentation fixes
1 parent 61726ae commit 507b9d4

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

doc/api.rst

+2
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Comparisons
7777

7878
Dataset.equals
7979
Dataset.identical
80+
Dataset.broadcast_equals
8081

8182
Indexing
8283
--------
@@ -236,6 +237,7 @@ Comparisons
236237

237238
DataArray.equals
238239
DataArray.identical
240+
DataArray.broadcast_equals
239241

240242
IO / Conversion
241243
===============

doc/examples/monthly-means.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _monthly means example:
2+
13
Calculating Seasonal Averages from Timeseries of Monthly Means
24
==============================================================
35

doc/whats-new.rst

+7-6
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,13 @@ Enhancements
116116
- Consolidated the functionality of ``dumps`` (writing a dataset to a netCDF3
117117
bytestring) into :py:meth:`~xray.Dataset.to_netcdf` (:issue:`333`).
118118
- :py:meth:`~xray.Dataset.to_netcdf` now supports writing to groups in netCDF4
119-
files (:issue:`333`). It also now has a full docstring -- you should read it!
119+
files (:issue:`333`). It also finally has a full docstring -- you should read
120+
it!
120121
- :py:func:`~xray.open_dataset` and :py:meth:`~xray.Dataset.to_netcdf` now
121122
work on netCDF4 files when netcdf4-python is not installed as long as scipy
122123
is available (:issue:`333`).
123-
- The new :py:meth:`xray.Dataset.drop <Dataset.drop>` and
124-
:py:meth:`xray.DataArray.drop <DataArray.drop>` methods makes it easy to drop
124+
- The new :py:meth:`Dataset.drop <xray.Dataset.drop>` and
125+
:py:meth:`DataArray.drop <xray.DataArray.drop>` methods makes it easy to drop
125126
explicitly listed variables or index labels:
126127

127128
.. ipython:: python
@@ -134,13 +135,13 @@ Enhancements
134135
arr = xray.DataArray([1, 2, 3], coords=[('x', list('abc'))])
135136
arr.drop(['a', 'c'], dim='x')
136137
137-
- The :py:meth:`~xray.Dataset.broadcast_equals` has been added to correspond to
138+
- :py:meth:`~xray.Dataset.broadcast_equals` has been added to correspond to
138139
the new ``compat`` option.
139140
- Long attributes are now truncated at 500 characters when printing a dataset
140141
(:issue:`337`). This should make things more convenient for working with
141142
datasets interactively.
142-
- Added a new `documentation example <examples/monthly-means>`_ on calculating
143-
properly weighted seasonal means. Thanks Joe Hamman!
143+
- Added a new documentation example, :ref:`monthly means example`. Thanks Joe
144+
Hamman!
144145

145146
Bug fixes
146147
~~~~~~~~~

0 commit comments

Comments
 (0)