Skip to content
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

Correct brackets in preprocessor documentation for list of seasons #1420

Merged
merged 1 commit into from
Jan 7, 2022
Merged

Correct brackets in preprocessor documentation for list of seasons #1420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions doc/recipe/preprocessor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1056,8 +1056,8 @@ See also :func:`esmvalcore.preprocessor.monthly_statistics`.
``seasonal_statistics``
-----------------------

This function produces statistics for each season (default: "(DJF, MAM, JJA,
SON)" or custom seasons e.g. "(JJAS, ONDJFMAM)" ) in the dataset. Note that
This function produces statistics for each season (default: ``[DJF, MAM, JJA,
SON]`` or custom seasons e.g. ``[JJAS, ONDJFMAM]``) in the dataset. Note that
this function will not check for missing time points. For instance, if you are
looking at the DJF field, but your datasets starts on January 1st, the first
DJF field will only contain data from January and February.
Expand All @@ -1070,9 +1070,9 @@ Parameters:
'median', 'std_dev', 'min', 'max', 'sum' and 'rms'. Default is 'mean'

* seasons: seasons to build statistics.
Default is '(DJF, MAM, JJA, SON)'
Default is '[DJF, MAM, JJA, SON]'

See also :func:`esmvalcore.preprocessor.seasonal_mean`.
See also :func:`esmvalcore.preprocessor.seasonal_statistics`.

.. _annual_statistics:

Expand Down Expand Up @@ -1118,7 +1118,7 @@ Parameters:
'mon', 'daily', 'day'. Default is 'full'

* seasons: if period 'seasonal' or 'season' allows to set custom seasons.
Default is '(DJF, MAM, JJA, SON)'
Default is '[DJF, MAM, JJA, SON]'

Examples:
* Monthly climatology:
Expand Down Expand Up @@ -1240,7 +1240,7 @@ Parameters:
parameters from extract_time_. Default is null
* standardize: if true calculate standardized anomalies (default: false)
* seasons: if period 'seasonal' or 'season' allows to set custom seasons.
Default is '(DJF, MAM, JJA, SON)'
Default is '[DJF, MAM, JJA, SON]'
Examples:
* Anomalies from the full period climatology:

Expand Down