Skip to content

Commit

Permalink
Clarity and typos
Browse files Browse the repository at this point in the history
Co-authored-by: Sadie L. Bartholomew <[email protected]>
  • Loading branch information
davidhassell and sadielbartholomew authored Apr 7, 2022
1 parent a878415 commit fc54aa1
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions cfdm/docstring/docstring.py
Original file line number Diff line number Diff line change
Expand Up @@ -310,8 +310,8 @@
returned.""",
# item: `bool`, optional
"{{item: `bool`, optional}}": """item: `bool`, optional
If True then return the selected construct identifier
and the construct itself. By default the construct
If True then return as a tuple the selected construct identifier
and the construct itself. By default only the construct
itself is returned. If *key* is True then *item* is
ignored.""",
# chunks subarrays
Expand Down
2 changes: 1 addition & 1 deletion cfdm/field.py
Original file line number Diff line number Diff line change
Expand Up @@ -1739,7 +1739,7 @@ def get_data_axes(self, *identity, default=ValueError(), **filter_kwargs):
`construct` for details.
If neither *identity* nor *filter_kwargs* are set then
the domain of the field constructs's data are
the domain of the field construct's data are
returned.
.. versionadded:: (cfdm) 1.9.1.0
Expand Down
4 changes: 2 additions & 2 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1525,7 +1525,7 @@ construct key, by any of the following techniques:
>>> c = t.constructs.get(key)
<AuxiliaryCoordinate: latitude(10, 9) degrees_N>

* with the `~Constructs.value` method of a `Constructs` instance, or
* with the `~Constructs.value` method of a `Constructs` instance.

.. code-block:: python
:caption: *Get the "latitude" metadata construct via its 'value'
Expand Down Expand Up @@ -1564,7 +1564,7 @@ of the chosen type.
>>> t.auxiliary_coordinate('latitude', item=True)
('auxiliarycoordinate0', <CF AuxiliaryCoordinate: latitude(10, 9) degrees_N>)

All of these techniques will raise an exception of there is not a
All of these techniques will raise an exception if there is not a
unique metadata construct to return, but this may be replaced with
returning a default value or raising a customised exception:

Expand Down

0 comments on commit fc54aa1

Please sign in to comment.