added a mention of options:experimentalFeatures in docs

SModelS · Oct 20, 2021 · 5495283 · 5495283
1 parent 711d32f
commit 5495283
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/manual/source/ReleaseUpdate.rst b/docs/manual/source/ReleaseUpdate.rst
@@ -46,7 +46,7 @@ New in Version 2.1.1:
   * tiny fix in mybinder link (see https://pypi.org/project/smodels/)
   * small fixes in unit tests
   * improved truncated Gaussians in likelihoodsFromLimits (but kept as experimental feature)
-  * experimental features can now be turned on via ini file
+  * :ref:`experimental features <parameterExperimentalFeatures>` can now be turned on via ini file
 
 New in Version 2.1.0:
 ^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/manual/source/RunningSModelS.rst b/docs/manual/source/RunningSModelS.rst
@@ -147,6 +147,10 @@ Below we give more detailed information about each entry in the parameters file.
 
   * **reportAllSRs** (True/False): set to True to report all signal regions, instead of best signal region only. Available from v2.1.1 onwards.
 
+.. _parameterExperimentalFeatures:
+
+  * **experimentalFeatures** (True/False): set to True to enable experimental features that are not yet considered part of SModelS proper. Available from v2.1.1 onwards. Use with care.
+
 .. _parameterFileParticles:
 
 * *particles*: defines the particle content of the BSM model