docs: added warnings to legacy functions

JeschkeLab · May 26, 2020 · d0e7925 · d0e7925
1 parent fd44e3d
commit d0e7925
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 0 deletions.
diff --git a/docsrc/source/functions/apt.rst b/docsrc/source/functions/apt.rst
@@ -7,6 +7,10 @@
 
 Approximate Pake transformation (APT) of dipolar spectroscopy data
 
+
+.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.
+
+
 -----------------------------
 
 

diff --git a/docsrc/source/functions/aptkernel.rst b/docsrc/source/functions/aptkernel.rst
@@ -7,6 +7,9 @@
 
 Computes the dipolar interaction kernel and components required for the approximate Pake transformation (APT).
 
+.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.
+
+
 -----------------------------
 
 

diff --git a/docsrc/source/functions/backgroundstart.rst b/docsrc/source/functions/backgroundstart.rst
@@ -7,6 +7,9 @@
 
 Computes the optimal point for starting the background fit
 
+.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.
+
+
 -----------------------------
 
 

diff --git a/docsrc/source/functions/correctscale.rst b/docsrc/source/functions/correctscale.rst
@@ -7,6 +7,10 @@
 
 Amplitude scale correction of dipolar spectroscopy signals
 
+
+.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.
+
+
 -----------------------------
 
 

diff --git a/docsrc/source/functions/fitbackground.rst b/docsrc/source/functions/fitbackground.rst
@@ -8,6 +8,9 @@
 
 Fit a parametric background model function to a dipolar signal
 
+.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.
+
+
 -----------------------------
 
 

diff --git a/docsrc/source/functions/time2dist.rst b/docsrc/source/functions/time2dist.rst
@@ -7,6 +7,9 @@
 
 Conversion from time-axis to distance-axis
 
+.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.
+
+
 -----------------------------
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,6 +7,10 @@

		Approximate Pake transformation (APT) of dipolar spectroscopy data


		.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.


		-----------------------------


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,6 +7,9 @@

		Computes the dipolar interaction kernel and components required for the approximate Pake transformation (APT).

		.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.


		-----------------------------


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,6 +7,9 @@

		Computes the optimal point for starting the background fit

		.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.


		-----------------------------


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,6 +7,10 @@

		Amplitude scale correction of dipolar spectroscopy signals


		.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.


		-----------------------------


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,6 +8,9 @@

		Fit a parametric background model function to a dipolar signal

		.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.


		-----------------------------


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,6 +7,9 @@

		Conversion from time-axis to distance-axis

		.. warning:: This is a legacy function. Its use is not recommended for routine or accurate data analysis.


		-----------------------------


Expand Down