Skip to content

Commit

Permalink
Generated gh-pages for commit a8d5198
Browse files Browse the repository at this point in the history
Merge: e80f019 5bcce8b
Author: alexcjohnson <johnson.alex.c@gmail.com>

    Merge pull request #339 from qdev-dk/feature/multiple_validator
  • Loading branch information
Documentation Bot committed Sep 22, 2016
1 parent 2e82b0c commit b4b8040
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 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 @@ -25,6 +25,7 @@ qcodes.utils.validators
Enum
Ints
MultiType
Multiples
Numbers
OnOff
Strings
Expand Down
11 changes: 7 additions & 4 deletions api/generated/qcodes.utils.validators.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,10 @@
<tr class="row-odd"><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">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">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>
<td><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
Expand All @@ -202,13 +205,13 @@
</table>
</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">OnOff</span></code>()</td>
<tr class="row-even"><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-even"><td><code class="xref py py-obj docutils literal"><span class="pre">Strings</span></code>([min_length,&nbsp;max_length])</td>
<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>
<td>requires a string</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">Validator</span></code>()</td>
<tr class="row-even"><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 b4b8040

Please sign in to comment.