Skip to content

Commit 7ec22fa

Browse files
bjlittlepp-mo
authored andcommitted
Minor doc changes. (#2631)
1 parent 682210c commit 7ec22fa

File tree

2 files changed

+15
-18
lines changed

2 files changed

+15
-18
lines changed

docs/iris/src/whatsnew/2.0a0.rst

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ What's New in Iris 2.0a0
22
************************
33

44
:Release: 2.0a0 (**alpha pre-release**)
5-
:Date: 2017-06-XX
5+
:Date: 2017-07-03
66

77

88
This document explains the new/changed features of Iris in version 2.0a0
@@ -15,16 +15,16 @@ Iris 2.0a0 Features
1515

1616
.. admonition:: Showcase Feature - Dask Integration
1717

18-
The use of `biggus`_ to provide support for *virtual arrays* and
19-
*lazy evaluation* within iris has been replaced with `dask`_.
18+
The use of `Biggus`_ to provide support for *virtual arrays* and
19+
*lazy evaluation* within Iris has been replaced with `Dask`_.
2020

2121
In addition the concept of *lazy data*, already used for the
22-
:class:`~iris.cube.Cube` data component, has now been extended to the data arrays in
23-
:class:`~iris.coords.Coord` s and :class:`~iris.aux_factory.AuxCoordFactory` s.
22+
:class:`~iris.cube.Cube` data component, has now been extended to the data array
23+
in a :class:`~iris.coords.Coord` and an :class:`~iris.aux_factory.AuxCoordFactory`.
2424

25-
This is a major feature enhancement, because basing Iris data in `dask`_
26-
allows iris to easily leverage its rich functionality and capabilities.
27-
In particular, dask's *threaded*, *multiprocessing* or *distributed*
25+
This is a major feature enhancement, because basing Iris data in Dask
26+
allows Iris to easily leverage its rich functionality and capabilities.
27+
In particular, Dask's *threaded*, *multiprocessing* or *distributed*
2828
`schedulers`_ can be used in order to fully exploit the available compute
2929
resource.
3030

@@ -99,7 +99,7 @@ Incompatible Changes
9999

100100
.. admonition:: Significant Changes in Calculated Results
101101

102-
Due to the replacement of biggus with dask, as described above, the results
102+
Due to the replacement of `Biggus`_ with `Dask`_, as described above, the results
103103
of certain types of calculation may have significantly different values from
104104
those obtained in earlier versions.
105105
This is of a much greater order than the usual small changes in floating
@@ -124,7 +124,7 @@ Incompatible Changes
124124
values of magnitude more than +/-2^52 (approximately 4.5e+15) may no longer
125125
be represented exactly.
126126

127-
It is hoped that, as dask matures, it may later be possible to remove these
127+
It is hoped that, as Dask matures, it may later be possible to remove these
128128
particular limitations.
129129

130130

@@ -143,10 +143,7 @@ Documentation Changes
143143
has been added, and referenced from key points in the :doc:`User Guide </userguide/index>` .
144144

145145

146-
.. _biggus: https://biggus.readthedocs.io/en/latest/
147-
.. _dask: http://dask.pydata.org/en/latest/
146+
.. _Biggus: https://biggus.readthedocs.io/en/latest/
147+
.. _Dask: http://dask.pydata.org/en/latest/
148148
.. _iris_grib: https://github.com/SciTools/iris-grib/
149-
.. _dask Array: http://dask.pydata.org/en/latest/array.html
150-
.. _dask Bags: http://dask.pydata.org/en/latest/bag.html
151-
.. _dask Delayed: http://dask.pydata.org/en/latest/delayed.html
152149
.. _schedulers: http://dask.pydata.org/en/latest/scheduler-overview.html

lib/iris/cube.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1600,7 +1600,7 @@ def cell_methods(self, cell_methods):
16001600
def core_data(self):
16011601
"""
16021602
Retrieve the data array of this :class:`~iris.cube.Cube` in its
1603-
current state, which may be either real or lazy.
1603+
current state, which will either be real or lazy.
16041604
16051605
If this :class:`~iris.cube.Cube` has lazy data, accessing its data
16061606
array via this method **will not** realise the data array. This means
@@ -1630,13 +1630,13 @@ def fill_value(self):
16301630
A fill value for the data of the :class:`~iris.cube.Cube`.
16311631
16321632
This is a value suitable for filling masked points in this cube's data.
1633-
It may be None, meaning that no suitable fill value is known.
1633+
It may be ``None``, meaning that no suitable fill value is known.
16341634
16351635
.. Note::
16361636
16371637
Ideally, this value will not occur anywhere in the cube data.
16381638
Thus, many operations that change cube data will also set
1639-
`fill_value` to None.
1639+
``fill_value`` to ``None``.
16401640
16411641
"""
16421642
return self._data_manager.fill_value

0 commit comments

Comments
 (0)