Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sistemicorp committed Apr 11, 2024
1 parent 971cda8 commit 505b9ad
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 32 deletions.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/prism_scripts.doctree
Binary file not shown.
16 changes: 7 additions & 9 deletions docs/build/html/_sources/prism_scripts.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -173,23 +173,21 @@ This section sets required variables that Prism uses to drive the test script.
::

"config": {
"result": "public.prism.result.ResultBaseV1",
"fail_fast": false,
"fail_fast": true,
"drivers": ["public.prism.drivers.fake.fake"]
},

``result``

* sets the result record type
* this is related to the back end database processing
* the dot notation is specifying a directory path to the python file to read
* its possible to extend the backend database to incorporate new fields for your application. See TBD

``fail_fast``

* this directive tells Prism whether to stop the test script on the first occurrance of a failed test
* this directive tells Prism whether to stop the test script on the first occurrence of a failed test
* this directive can be overridden by the directive in the ``options`` section of the ``tests`` section - in other
words, here it has the least priority
* it is recommended ``fail_fast`` be set to `true`.

* Often tests are interdependent, and if one test fails, it often means other tests will fail that depended on
that particular function. What happens then is a cascade of failed tests which my might obscure the root failure.
* If tests are mutually exclusive, it may be advantages to set ``fail_fast`` to `false`.

``drivers``

Expand Down
19 changes: 9 additions & 10 deletions docs/build/html/prism_scripts.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,24 +196,23 @@ <h2>info<a class="headerlink" href="#info" title="Permalink to this headline">¶
<h2>config<a class="headerlink" href="#config" title="Permalink to this headline"></a></h2>
<p>This section sets required variables that Prism uses to drive the test script.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">&quot;config&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;result&quot;</span><span class="p">:</span> <span class="s2">&quot;public.prism.result.ResultBaseV1&quot;</span><span class="p">,</span>
<span class="s2">&quot;fail_fast&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s2">&quot;fail_fast&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s2">&quot;drivers&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;public.prism.drivers.fake.fake&quot;</span><span class="p">]</span>
<span class="p">},</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">result</span></code></p>
<ul class="simple">
<li><p>sets the result record type</p></li>
<li><p>this is related to the back end database processing</p></li>
<li><p>the dot notation is specifying a directory path to the python file to read</p></li>
<li><p>its possible to extend the backend database to incorporate new fields for your application. See TBD</p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">fail_fast</span></code></p>
<ul class="simple">
<li><p>this directive tells Prism whether to stop the test script on the first occurrance of a failed test</p></li>
<li><p>this directive tells Prism whether to stop the test script on the first occurrence of a failed test</p></li>
<li><p>this directive can be overridden by the directive in the <code class="docutils literal notranslate"><span class="pre">options</span></code> section of the <code class="docutils literal notranslate"><span class="pre">tests</span></code> section - in other
words, here it has the least priority</p></li>
<li><p>it is recommended <code class="docutils literal notranslate"><span class="pre">fail_fast</span></code> be set to <cite>true</cite>.</p>
<ul>
<li><p>Often tests are interdependent, and if one test fails, it often means other tests will fail that depended on
that particular function. What happens then is a cascade of failed tests which my might obscure the root failure.</p></li>
<li><p>If tests are mutually exclusive, it may be advantages to set <code class="docutils literal notranslate"><span class="pre">fail_fast</span></code> to <cite>false</cite>.</p></li>
</ul>
</li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">drivers</span></code></p>
<ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Large diffs are not rendered by default.

16 changes: 7 additions & 9 deletions docs/source/prism_scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,23 +173,21 @@ This section sets required variables that Prism uses to drive the test script.
::

"config": {
"result": "public.prism.result.ResultBaseV1",
"fail_fast": false,
"fail_fast": true,
"drivers": ["public.prism.drivers.fake.fake"]
},

``result``

* sets the result record type
* this is related to the back end database processing
* the dot notation is specifying a directory path to the python file to read
* its possible to extend the backend database to incorporate new fields for your application. See TBD

``fail_fast``

* this directive tells Prism whether to stop the test script on the first occurrance of a failed test
* this directive tells Prism whether to stop the test script on the first occurrence of a failed test
* this directive can be overridden by the directive in the ``options`` section of the ``tests`` section - in other
words, here it has the least priority
* it is recommended ``fail_fast`` be set to `true`.

* Often tests are interdependent, and if one test fails, it often means other tests will fail that depended on
that particular function. What happens then is a cascade of failed tests which my might obscure the root failure.
* If tests are mutually exclusive, it may be advantages to set ``fail_fast`` to `false`.

``drivers``

Expand Down
6 changes: 3 additions & 3 deletions public/VERSION
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
prev_commit=e213af0676afefc3e4f38f90c5a0bcaa3cfee773
date=2024-04-10 20:59:51 -0400
prev_commit=971cda8d0c226423b4b5e73d5aabb74b63284293
date=2024-04-11 10:35:52 -0400
branch=master
version=0.7-6-ge213af0
version=0.7-7-g971cda8

0 comments on commit 505b9ad

Please sign in to comment.