From fb01a1412e70f09434b57a286fc2de0258281286 Mon Sep 17 00:00:00 2001
From: Johannes Mueller <johannes.mueller4@de.bosch.com>
Date: Tue, 8 Feb 2022 17:19:56 +0100
Subject: [PATCH] Add beta warnings to the docs

Signed-off-by: Johannes Mueller <johannes.mueller4@de.bosch.com>
---
 src/pylife/materialdata/woehler/bayesian.py |  9 +++++++++
 src/pylife/stress/frequencysignal.py        | 13 +++++++++++--
 src/pylife/stress/timesignal.py             | 15 ++++++++++-----
 3 files changed, 30 insertions(+), 7 deletions(-)

diff --git a/src/pylife/materialdata/woehler/bayesian.py b/src/pylife/materialdata/woehler/bayesian.py
index c435c977..05d079b5 100644
--- a/src/pylife/materialdata/woehler/bayesian.py
+++ b/src/pylife/materialdata/woehler/bayesian.py
@@ -14,6 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 __author__ = "Mustapha Kassem"
 __maintainer__ = "Johannes Mueller"
 
@@ -27,6 +28,14 @@
 
 
 class Bayesian(Elementary):
+    """A Wöhler analyzer using Bayesian optimization
+
+    Warning
+    -------
+
+    We are considering switching from pymc3 to GPyOpt as calculation engine in the
+    future.  Maybe this will lead to breaking changes without new major release.
+    """
 
     class _LogLike(tt.Op):
         """
diff --git a/src/pylife/stress/frequencysignal.py b/src/pylife/stress/frequencysignal.py
index 279989f0..773ac058 100644
--- a/src/pylife/stress/frequencysignal.py
+++ b/src/pylife/stress/frequencysignal.py
@@ -13,11 +13,20 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+"""A module for frequency signal handling
+
+Warning
+-------
+
+This module is not considered finalized even though it is part of pylife-2.0.
+Breaking changes might occur in upcoming minor releases.
+"""
+
 import numpy as np
 import pandas as pd
 from scipy import optimize as op
 
-
 class psdSignal:
     '''Handles different routines for self signals
 
@@ -94,4 +103,4 @@ def psd_smoother(self,fsel,factor_rms_nodes = 0.5):
                              args=(df_in,fsel,factor_rms_nodes))
             opt_df[colact] =  10**np.interp(fout,fsel,np.log10(Hi.x))
         opt_df.index = fout
-        return opt_df
\ No newline at end of file
+        return opt_df
diff --git a/src/pylife/stress/timesignal.py b/src/pylife/stress/timesignal.py
index 65d76a46..7be113f9 100644
--- a/src/pylife/stress/timesignal.py
+++ b/src/pylife/stress/timesignal.py
@@ -14,6 +14,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""A module for time signal handling
+
+Warning
+-------
+
+This module is not considered finalized even though it is part of pylife-2.0.
+Breaking changes might occur in upcoming minor releases.
+"""
+
 __author__ = "Johannes Mueller"
 __maintainer__ = __author__
 
@@ -34,11 +43,7 @@
 class TimeSignalGenerator:
     r"""Generates mixed time signals
 
-    The generated time signal is a mixture of random sets of
-
-    * sinus signals
-    * gauss signals (not yet)
-    * log gauss signals (not yet)
+    The generated time signal is a mixture of random sets of sinus signals
 
     For each set the user supplys a dict describing the set::