From d0e7925f81c0cdeb6ce0aac4eb8d28f9746408a8 Mon Sep 17 00:00:00 2001 From: Luis Fabregas Date: Tue, 26 May 2020 14:08:32 +0200 Subject: [PATCH] docs: added warnings to legacy functions --- docsrc/source/functions/apt.rst | 4 ++++ docsrc/source/functions/aptkernel.rst | 3 +++ docsrc/source/functions/backgroundstart.rst | 3 +++ docsrc/source/functions/correctscale.rst | 4 ++++ docsrc/source/functions/fitbackground.rst | 3 +++ docsrc/source/functions/time2dist.rst | 3 +++ 6 files changed, 20 insertions(+) diff --git a/docsrc/source/functions/apt.rst b/docsrc/source/functions/apt.rst index d03264c9..62870460 100644 --- 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 index 8538cd2e..309e0dcc 100644 --- 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 index 3700b713..2784f7ea 100644 --- 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 index e7ec9e8a..22173642 100644 --- 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 index 68c0ab7a..15e285af 100644 --- 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 index 045fcb45..f9aad84b 100644 --- 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. + + -----------------------------