Skip to content

Commit bf759df

Browse files
committed
Update docs
1 parent 327d6da commit bf759df

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

Extend_Template.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@
151151
"Within this folder create two python files:\n",
152152
"1. {{cookiecutter.plugin_name}}.py.\n",
153153
" - This file will contain the default function layout for all plugins of this type.\n",
154-
" - This file can be copied almost directly from {{cookiecutter.project_name}}/{{cookiecutter.project_slug}}.postrocessor. The only adjustments which need to be made are changing the input and output variables of the function to better match a what is required from this type of plugin.\n",
154+
" - This file can be copied almost directly from {{cookiecutter.project_name}}/{{cookiecutter.project_slug}}.postprocessor. The only adjustments which need to be made are changing the input and output variables of the function to better match a what is required from this type of plugin.\n",
155155
"2. \\_\\_init\\_\\_.py\n",
156156
" - This file will import the functions from the {{cookiecutter.plugin_name}} file"
157157
]

docs/diagnostics_module_example.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@
66
in this module and other relevant information.
77
"""
88

9-
# Function {{ cookiecutter.plugin_name }} to create diagnostic postprocessing plugins.
9+
# Function {{ cookiecutter.plugin_name }} to create diagnostic plugins.
1010

11-
# IMPORTANT: The name of the diagnostic postprocessor should follow the "diagnostic_name"
12-
# naming convention. The "diagnostics_" prefix to the diagnostic postprocessor name is MANDATORY since it is
11+
# IMPORTANT: The name of the diagnostic should follow the "diagnostic_name"
12+
# naming convention. The "diagnostics_" prefix to the diagnostic name is MANDATORY since it is
1313
# used by the pysteps interface.
1414
#
15-
# Check the pysteps documentation for examples of diagnostic postprocessor names that follow this
15+
# Check the pysteps documentation for examples of diagnostic names that follow this
1616
# convention:
1717
# https://pysteps.readthedocs.io/en/latest/pysteps_reference/io.html#available-diagnostics
1818
#
19-
# The function prototype for the diagnostic postprocessor's declaration should have the following form:
19+
# The function prototype for the diagnostic's declaration should have the following form:
2020
#
2121
# def diagnostics_xyz(filename, **kwargs):
2222
#
@@ -27,7 +27,7 @@
2727
# The function arguments should have the following form:
2828
# (filename, keyword1="some_keyword", keyword2=10,...,keywordN="something", **kwargs)
2929
# The `filename` and `**kwargs` arguments are mandatory to comply with the pysteps
30-
# interface. To fine-control the behavior of the diagnostic postprocessor, additional keywords can be
30+
# interface. To fine-control the behavior of the diagnostic, additional keywords can be
3131
# added to the function.
3232
# For example: keyword1="some_keyword", keyword2=10, ..., keywordN="something"
3333
# It is recommended to declare the keywords explicitly in the function to improve the
@@ -37,15 +37,15 @@
3737
# Return arguments
3838
# ~~~~~~~~~~~~~~~~
3939
#
40-
# The diagnostic postprocessor can return whatever argument is needed.
40+
# The diagnostic can return whatever argument is needed.
4141
#
4242
#
4343

4444

45-
def postprocessor_diagnostics_calc(filename, **kwargs):
45+
def diagnostics_calc(filename, **kwargs):
4646
"""
47-
A detailed description of the diagnostic postprocessor. A minimal documentation is
48-
strictly needed since the pysteps postprocessor interface expect docstrings.
47+
A detailed description of the diagnostic. A minimal documentation is
48+
strictly needed since the pysteps postprocessing interface expect docstrings.
4949
5050
For example, a documentation may look like this:
5151
@@ -57,18 +57,18 @@ def postprocessor_diagnostics_calc(filename, **kwargs):
5757
Name of the file to be processed.
5858
5959
keyword1 : str
60-
Some keyword used to fine control the diagnostic postprocessor behaviour.
60+
Some keyword used to fine control the diagnostic behaviour.
6161
6262
keyword2 : int
63-
Another keyword used to fine control the diagnostic postprocessor behaviour.
63+
Another keyword used to fine control the diagnostic behaviour.
6464
6565
{extra_kwargs_doc}
6666
6767
Returns
6868
-------.
6969
"""
7070
####################################################################################
71-
# Add the code required to run the diagnostic postprocessor here.
71+
# Add the code required to run the diagnostics here.
7272
file = open(filename, "w")
7373
file.write("hello world")
7474
file.close()

0 commit comments

Comments
 (0)