Skip to content

Commit 4176d15

Browse files
authored
Documentation updates for v3.4.0rc0 release. (#5078)
* Finalise v3.4 What's New. * Update What's New index. * 3.4 what's new small search engine change. * Hard-coded release information in What's New.
1 parent 1c05e92 commit 4176d15

File tree

3 files changed

+23
-121
lines changed

3 files changed

+23
-121
lines changed

docs/src/whatsnew/latest.rst renamed to docs/src/whatsnew/3.4.rst

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. include:: ../common_links.inc
22

3-
|iris_version| |build_date| [unreleased]
4-
****************************************
3+
v3.4 (17 Nov 2022) [release candidate]
4+
**************************************
55

66
This document explains the changes made to Iris for this release
77
(:doc:`View all changes <index>`.)
@@ -14,9 +14,22 @@ This document explains the changes made to Iris for this release
1414
:animate: fade-in
1515
:open:
1616

17-
The highlights for this major/minor release of Iris include:
18-
19-
* N/A
17+
The highlights for this minor release of Iris include:
18+
19+
* We have **archived older Iris documentation** - everything before
20+
``v3.0.0`` - so older versions will soon no longer appear in search
21+
engines. If you need this older documentation: please
22+
see :ref:`iris_support`.
23+
* We have added a :ref:`glossary` to the Iris documentation.
24+
* We have completed work to make **Pandas interoperability** handle
25+
n-dimensional :class:`~iris.cube.Cube`\s.
26+
* We have **begun refactoring Iris' regridding**, which has already improved
27+
performance and functionality, with more potential in future!
28+
* We have made several other significant `🚀 Performance Enhancements`_.
29+
* Please note that **Iris cannot currently work with the latest NetCDF4
30+
releases**. The pin is set to ``<v1.6.1``, due to incompatibility with
31+
Iris' lack of thread safety. We're working hard to make Iris NetCDF
32+
loading thread safe as soon as possible.
2033

2134
And finally, get in touch with us on :issue:`GitHub<new/choose>` if you have
2235
any issues or feature requests for improving Iris. Enjoy!
@@ -226,8 +239,9 @@ This document explains the changes made to Iris for this release
226239
#. `@tkknight`_ updated the links for the Iris documentation to v2.4 and
227240
earlier to point to the archive of zip files instead. (:pull:`5064`)
228241

229-
#. `@Esadek-MO`_ added notes at the bottom of functions to
230-
to clarify if the function preserves laziness or not. (:pull:`5066`)
242+
#. `@Esadek-MO`_ began adding notes at the bottom of functions to
243+
to clarify if the function preserves laziness or not. See :issue:`3292` for
244+
the ongoing checklist. (:pull:`5066`)
231245

232246
💼 Internal
233247
===========

docs/src/whatsnew/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
What's New in Iris
66
------------------
77

8-
.. include:: latest.rst
8+
.. include:: 3.4.rst
99

1010
.. toctree::
1111
:maxdepth: 1
1212
:hidden:
1313

14-
latest.rst
14+
3.4.rst
1515
3.3.rst
1616
3.2.rst
1717
3.1.rst

docs/src/whatsnew/latest.rst.template

Lines changed: 0 additions & 112 deletions
This file was deleted.

0 commit comments

Comments
 (0)