Add note to warn about failing tests

joserapa98 · May 10, 2024 · d934319 · d934319
1 parent 2e190ff
commit d934319
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -79,6 +79,12 @@ python -m pytest -v
 
 inside the repository folder.
 
+> [!NOTE]
+Certain tests may experience failure as a result of statistical anomalies or 
+hardware constraints. We advise reviewing the error messages to determine if 
+these failures stem from such occurrences. Should this be the case, consider 
+rerunning the tests to ascertain if the errors persist.
+
 
 ## Example
 

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -45,6 +45,12 @@ Installation
 .. include:: installation.rst
    :start-line: 3
 
+.. note::
+   Certain tests may experience failure as a result of statistical anomalies or 
+   hardware constraints. We advise reviewing the error messages to determine if 
+   these failures stem from such occurrences. Should this be the case, consider 
+   rerunning the tests to ascertain if the errors persist.
+
 
 Example
 =======

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -522,6 +522,13 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </pre></div>
 </div>
 <p>inside the repository folder.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Certain tests may experience failure as a result of statistical anomalies or
+hardware constraints. We advise reviewing the error messages to determine if
+these failures stem from such occurrences. Should this be the case, consider
+rerunning the tests to ascertain if the errors persist.</p>
+</div>
 </section>
 <section id="example">
 <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">#</a></h2>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/index.rst b/docs/index.rst
@@ -45,6 +45,12 @@ Installation
 .. include:: installation.rst
    :start-line: 3
 
+.. note::
+   Certain tests may experience failure as a result of statistical anomalies or 
+   hardware constraints. We advise reviewing the error messages to determine if 
+   these failures stem from such occurrences. Should this be the case, consider 
+   rerunning the tests to ascertain if the errors persist.
+
 
 Example
 =======