Skip to content

Commit b681833

Browse files
Update usage of deprecated keyword in tutorial
1 parent 9f05fc6 commit b681833

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

docs/source/releases.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Documentation for all versions of cf.
1616
**CF-1.12**
1717
-----------
1818

19-
* `Version 3.17.0 <https://ncas-cms.github.io/cf-python-docs/3.17.0>`_ (2025-03-??)
19+
* `Version 3.17.0 <https://ncas-cms.github.io/cf-python-docs/3.17.0>`_ (2025-03-24)
2020

2121
**CF-1.11**
2222
-----------

docs/source/tutorial.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,11 +188,12 @@ cards). Shell environment variables are also permitted.
188188
>>> len(z)
189189
3
190190
191-
All of the datasets in one more directories may also be read by
191+
All of the datasets in one or more directories may also be read by
192192
replacing any file name with a directory name. An attempt will be made
193193
to read all files in the directory, which will result in an error if
194194
any have a non-supported format. Non-supported files may be ignored
195-
with the *ignore_read_error* keyword.
195+
by being more specific about the file type intended for reading in
196+
using the *file_type* keyword:
196197

197198
.. code-block:: python
198199
:caption: *Read all of the files in the current working directory.*
@@ -201,7 +202,7 @@ with the *ignore_read_error* keyword.
201202
Traceback (most recent call last):
202203
...
203204
Exception: Can't determine format of file cf_tutorial_files.zip
204-
>>> y = cf.read('$PWD', ignore_read_error=True)
205+
>>> y = cf.read('$PWD', file_type='netCDF')
205206
>>> len(y)
206207
15
207208

0 commit comments

Comments
 (0)