Merge pull request #155 from guillermoaguilar/docs-warnings

docs: adds warning on all pages again with proper syntax, also on generated examples
wichmann-lab · Oct 15, 2024 · 640d0a4 · 640d0a4
2 parents 08cac29 + 648908e
commit 640d0a4
Show file tree

Hide file tree

Showing 20 changed files with 52 additions and 23 deletions.
diff --git a/docs/examples/demo_001.md b/docs/examples/demo_001.md
@@ -11,6 +11,9 @@ kernelspec:
   name: python3
 ---
 
+```{warning}
+This documentation page is still work in progress! Some information might be outdated.
+```
 
 # 1. Basic Usage
 

diff --git a/docs/examples/demo_002.md b/docs/examples/demo_002.md
@@ -11,6 +11,9 @@ kernelspec:
   name: python3
 ---
 
+```{warning}
+This documentation page is still work in progress! Some information might be outdated.
+```
 
 # 2. More Options
 

diff --git a/docs/examples/demo_003.md b/docs/examples/demo_003.md
@@ -11,6 +11,9 @@ kernelspec:
   name: python3
 ---
 
+```{warning}
+This documentation page is still work in progress! Some information might be outdated.
+```
 
 # 3. Result Object
 

diff --git a/docs/examples/demo_004.md b/docs/examples/demo_004.md
@@ -11,6 +11,10 @@ kernelspec:
   name: python3
 ---
 
+```{warning}
+This documentation page is still work in progress! Some information might be outdated.
+```
+
 
 # 4. Priors
 

diff --git a/docs/examples/demo_005.md b/docs/examples/demo_005.md
@@ -11,6 +11,10 @@ kernelspec:
   name: python3
 ---
 
+```{warning}
+This documentation page is still work in progress! Some information might be outdated.
+```
+
 
 # 5. Plotting
 

diff --git a/docs/examples/demo_006.md b/docs/examples/demo_006.md
@@ -11,6 +11,10 @@ kernelspec:
   name: python3
 ---
 
+```{warning}
+This documentation page is still work in progress! Some information might be outdated.
+```
+
 
 # 6. Additional Functionality
 

diff --git a/docs/examples/parameter_recovery_demo.md b/docs/examples/parameter_recovery_demo.md
@@ -13,6 +13,10 @@ kernelspec:
   name: python3
 ---
 
+```{warning}
+This documentation page is still work in progress! Some information might be outdated.
+```
+
 +++ {"nteract": {"transient": {"deleting": false}}}
 
 # Parameter Recovery Demo

diff --git a/docs/examples/plot_all_sigmoids.md b/docs/examples/plot_all_sigmoids.md
@@ -11,6 +11,10 @@ kernelspec:
   name: python3
 ---
 
+```{warning}
+This documentation page is still work in progress! Some information might be outdated.
+```
+
 
 # Plot Sigmoids
 

diff --git a/docs/how_to/How-to-Change-the-Threshold-Percent-Correct.rst b/docs/how_to/How-to-Change-the-Threshold-Percent-Correct.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _how-to-change-threshold-percent-correct:
 
 How to: Change the Threshold Percent Correct

diff --git a/docs/how_to/How-to-Fix-Parameters.rst b/docs/how_to/How-to-Fix-Parameters.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _how-to-fix-parameters:
 
 How to: Fix Parameters

diff --git a/docs/how_to/How-to-Get-Standard-Parameters.rst b/docs/how_to/How-to-Get-Standard-Parameters.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _how-to-get-standard-parameters:
 
 How to: Get Standard Parameters

diff --git a/docs/how_to/How-to-Get-Thresholds-and-Slopes.rst b/docs/how_to/How-to-Get-Thresholds-and-Slopes.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _how-to-get-thresholds-and-slopes:
 
 How To: Get Thresholds and Slopes

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
-.. WARNING::
-   This documentation page is still work in progress! Some information might be outdated.
+.. warning::
+   Some parts of this documentation are still work in progress! Some information might be outdated.
 
 .. psignifit documentation master file
 

diff --git a/docs/user_guides/Experiment-Types.rst b/docs/user_guides/Experiment-Types.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _experiment-types:
 
 Experiment Types

diff --git a/docs/user_guides/Interval-Bias.rst b/docs/user_guides/Interval-Bias.rst
@@ -1,4 +1,4 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
 
 .. _interval-bias:

diff --git a/docs/user_guides/Options-Dictionary.rst b/docs/user_guides/Options-Dictionary.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _options-dictionary:
 
 Options Dictionary

diff --git a/docs/user_guides/Plot-Functions.rst b/docs/user_guides/Plot-Functions.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _plot-functions:
 
 Plot Functions

diff --git a/docs/user_guides/Pooling-Utility.rst b/docs/user_guides/Pooling-Utility.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _pooling-utility:
 
 Pooling Utility

diff --git a/docs/user_guides/Priors.rst b/docs/user_guides/Priors.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _priors:
 
 Priors

diff --git a/docs/user_guides/Result-Struct.rst b/docs/user_guides/Result-Struct.rst
@@ -1,6 +1,6 @@
-.. WARNING::
+.. warning::
    This documentation page is still work in progress! Some information might be outdated.
-   
+
 .. _result-struct:
 
 Result Struct