Skip to content

Commit 3ca053d

Browse files
committed
Docstring revisions
1 parent 685b598 commit 3ca053d

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

pysteps/noise/motion.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ def initialize_bps(V, pixelsperkm, timestep, p_pert_par=None, p_pert_perp=None,
3838
randstate=np.random, seed=None):
3939
"""Initialize the motion field perturbator described in :cite:`BPS2006`.
4040
For simplicity, the bias adjustment procedure described there has not been
41-
implemented. The perturbator generates a constant field whose magnitude
42-
depends on lead time.
41+
implemented. The perturbator generates a field whose magnitude increases
42+
with respect to lead time.
4343
4444
Parameters
4545
----------

pysteps/nowcasts/steps.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,19 +109,19 @@ def forecast(R, V, n_timesteps, n_ens_members=24, n_cascade_levels=6, R_thr=None
109109
all available CPUs. Applicable if dask is enabled.
110110
fft_method : str or tuple
111111
A string or a (function,kwargs) tuple defining the FFT method to use
112-
(see utils.fft.get_method). Defaults to "numpy".
112+
(see utils.fft.get_method). Defaults to 'numpy'.
113113
extrap_kwargs : dict
114-
Optional dictionary that is supplied as keyword arguments to the
115-
extrapolation method.
114+
Optional dictionary containing keyword arguments for the extrapolation
115+
method. See the documentation of pysteps.extrapolation.
116116
filter_kwargs : dict
117-
Optional dictionary that is supplied as keyword arguments to the
118-
filter method.
117+
Optional dictionary containing keyword arguments for the filter method.
118+
See the documentation of pysteps.cascade.bandpass_filters.py.
119119
noise_kwargs : dict
120-
Optional dictionary that is supplied as keyword arguments to the
121-
initializer of the noise generator.
120+
Optional dictionary containing keyword arguments for the initializer of
121+
the noise generator. See the documentation of pysteps.noise.fftgenerators.
122122
vel_pert_kwargs : dict
123-
Optional dictionary that is supplied as keyword arguments to the
124-
initializer of the velocity perturbator.
123+
Optional dictionary containing keyword arguments for the initializer of
124+
the velocity perturbator. See the documentation of pysteps.noise.motion.
125125
126126
Returns
127127
-------

0 commit comments

Comments
 (0)