Skip to content

DOCS: numpydocs 6 #5718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 30, 2024
Merged

DOCS: numpydocs 6 #5718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7d64ae2
numpydocs
tkknight Jan 28, 2024
044900d
minor docstring fixes
tkknight Jan 28, 2024
07cd05e
Merge branch 'main' into numppydocs_6
tkknight Jan 28, 2024
be97e45
fix doctests
tkknight Jan 28, 2024
b6ea2be
Merge branch 'main' into numppydocs_6
tkknight Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/further_topics/filtering_warnings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Warnings:
...
iris/coord_systems.py:442: IrisUserWarning: Setting inverse_flattening does not affect other properties of the GeogCS object. To change other properties set them explicitly or create a new GeogCS instance.
warnings.warn(wmsg, category=iris.exceptions.IrisUserWarning)
iris/coord_systems.py:782: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
iris/coord_systems.py:768: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
warnings.warn(

Warnings can be suppressed using the Python warnings filter with the ``ignore``
Expand Down Expand Up @@ -130,7 +130,7 @@ Or you can target Warnings raised by specific lines of specific modules, e.g.
...
iris/coord_systems.py:442: IrisUserWarning: Setting inverse_flattening does not affect other properties of the GeogCS object. To change other properties set them explicitly or create a new GeogCS instance.
warnings.warn(wmsg, category=iris.exceptions.IrisUserWarning)
iris/coord_systems.py:782: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
iris/coord_systems.py:768: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
warnings.warn(

::
Expand Down
8 changes: 4 additions & 4 deletions lib/iris/coord_categorisation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def add_categorised_coord(cube, name, from_coord, category_function, units="1"):
category_function : callable
function(coordinate, value), returning a category value for a
coordinate point-value
units : str, optional, default="1"
units : str, default="1"
units of the category value, typically 'no_unit' or '1'.
"""
# Interpret coord, if given as a name
Expand Down Expand Up @@ -303,7 +303,7 @@ def add_season(cube, coord, name="season", seasons=("djf", "mam", "jja", "son"))
it.
coord : :class:`iris.coords.Coord` or str
Coordinate in 'cube', or its name, representing time.
name : str, optional
name : str, default="season"
Name of the created coordinate. Defaults to "season".
seasons : :class:`list` of str, optional
List of seasons defined by month abbreviations. Each month must
Expand Down Expand Up @@ -341,7 +341,7 @@ def add_season_number(
it.
coord : :class:`iris.coords.Coord` or str
Coordinate in 'cube', or its name, representing time.
name : str, optional
name : str, default="season"
Name of the created coordinate. Defaults to "season_number".
seasons : :class:`list` of str, optional
List of seasons defined by month abbreviations. Each month must
Expand Down Expand Up @@ -425,7 +425,7 @@ def add_season_membership(cube, coord, season, name="season_membership"):
Coordinate in 'cube', or its name, representing time.
season : str
Season defined by month abbreviations.
name : str, optional
name : str, default="season_membership"
Name of the created coordinate. Defaults to "season_membership".

"""
Expand Down
Loading