Skip to content

Commit

Permalink
Generated gh-pages for commit 35515fa
Browse files Browse the repository at this point in the history
Merge: 474158b 8efc95b
Author: alexcjohnson <johnson.alex.c@gmail.com>

    Merge pull request #342 from qdev-dk/array_val
  • Loading branch information
Documentation Bot committed Sep 23, 2016
1 parent b4b8040 commit 0d5efe4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
1 change: 1 addition & 0 deletions _sources/api/generated/qcodes.utils.validators.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ qcodes.utils.validators
.. autosummary::

Anything
Arrays
Bool
Enum
Ints
Expand Down
21 changes: 12 additions & 9 deletions api/generated/qcodes.utils.validators.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,22 +178,25 @@
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Anything</span></code>()</td>
<td>allow any value to pass</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Bool</span></code>()</td>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Arrays</span></code>([min_value,&nbsp;max_value,&nbsp;shape])</td>
<td>Validator for numerical numpy arrays</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Bool</span></code>()</td>
<td>requires a boolean</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Enum</span></code>(*values)</td>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Enum</span></code>(*values)</td>
<td>requires one of a provided set of values</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Ints</span></code>([min_value,&nbsp;max_value])</td>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Ints</span></code>([min_value,&nbsp;max_value])</td>
<td>requires an integer</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">MultiType</span></code>(*validators)</td>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">MultiType</span></code>(*validators)</td>
<td>allow the union of several different validators</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Multiples</span></code>([divisor])</td>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Multiples</span></code>([divisor])</td>
<td>A validator that checks if a value is an integer multiple of a fixed devisor This class extends validators.Ints such that the value is also checked for being integer between an optional min_value and max_value.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Numbers</span></code>([min_value,&nbsp;max_value])</td>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Numbers</span></code>([min_value,&nbsp;max_value])</td>
<td><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
Expand All @@ -205,13 +208,13 @@
</table>
</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">OnOff</span></code>()</td>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">OnOff</span></code>()</td>
<td>requires either the string &#8216;on&#8217; or &#8216;off&#8217;</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Strings</span></code>([min_length,&nbsp;max_length])</td>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Strings</span></code>([min_length,&nbsp;max_length])</td>
<td>requires a string</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Validator</span></code>()</td>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Validator</span></code>()</td>
<td>base class for all value validators</td>
</tr>
</tbody>
Expand Down

0 comments on commit 0d5efe4

Please sign in to comment.