From de5f73cb7eeef5685468603df427084a0adf1144 Mon Sep 17 00:00:00 2001
From: Daniel Weindl <daniel.weindl@uni-bonn.de>
Date: Wed, 4 Dec 2024 11:26:46 +0100
Subject: [PATCH] Clarify meaning of `initializationPrior*`

Consensus seems to be that the use of initialization priors is optional.

Closes #587.
---
 doc/v2/documentation_data_format.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/v2/documentation_data_format.rst b/doc/v2/documentation_data_format.rst
index a969fbe9..e80b13eb 100644
--- a/doc/v2/documentation_data_format.rst
+++ b/doc/v2/documentation_data_format.rst
@@ -579,6 +579,11 @@ Detailed field description
   points are clipped to lie inside the parameter boundaries specified by
   ``lowerBound`` and ``upperBound``. Defaults to ``parameterScaleUniform``.
 
+  This is a hint for the optimization algorithm to start the optimization
+  process or for re-sampling random points. The initialization prior does not
+  change the objective function itself. Optimizers may choose to ignore this
+  information.
+
   Possible prior types are:
 
     - *uniform*: flat prior on linear parameters