From 996ae2bd3d8a832a3c9f423562b218528dc67245 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Tue, 10 Dec 2024 00:19:31 +0100 Subject: [PATCH] Fix get_parameter_prior_dict docstring Documentation did not match the code. --- pypesto/objective/priors.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pypesto/objective/priors.py b/pypesto/objective/priors.py index 4ffcdaf6a..9164c70b2 100644 --- a/pypesto/objective/priors.py +++ b/pypesto/objective/priors.py @@ -244,11 +244,13 @@ def get_parameter_prior_dict( "parameterScaleUniform", "parameterScaleNormal", "parameterScaleLaplace"} prior_parameters: - Parameters of the priors. Parameters are defined in linear scale. + Parameters of the priors. Parameters are defined in the parameter + scale if the `prior_type` starts with ``parameterScale``, otherwise in + the linear scale. parameter_scale: scale in which the parameter is defined (since a parameter can be log-transformed, while the prior is always defined in the linear - space, unless it starts with "parameterScale") + space, unless it starts with ``parameterScale``). """ log_f, d_log_f_dx, dd_log_f_ddx, res, d_res_dx = _prior_densities( prior_type, prior_parameters