Skip to content

Commit

Permalink
Add changes for c228196
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jun 17, 2024
1 parent 4ea7d21 commit 7f0c8f3
Show file tree
Hide file tree
Showing 10 changed files with 104 additions and 16 deletions.
16 changes: 16 additions & 0 deletions Reference/code.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@
<li class="toctree-l4"><a class="reference internal" href="#sarracenia.config.no_file_config"><code class="docutils literal notranslate"><span class="pre">no_file_config()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#sarracenia.config.octal_number"><code class="docutils literal notranslate"><span class="pre">octal_number</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#sarracenia.config.one_config"><code class="docutils literal notranslate"><span class="pre">one_config()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#sarracenia.config.parse_count"><code class="docutils literal notranslate"><span class="pre">parse_count()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#sarracenia.config.parse_float"><code class="docutils literal notranslate"><span class="pre">parse_float()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#sarracenia.config.str_options"><code class="docutils literal notranslate"><span class="pre">str_options</span></code></a></li>
</ul>
</li>
Expand Down Expand Up @@ -945,6 +947,20 @@
<p>appdir_stuff can be to override file locations for testing during development.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="sarracenia.config.parse_count">
<span class="sig-prename descclassname"><span class="pre">sarracenia.config.</span></span><span class="sig-name descname"><span class="pre">parse_count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cstr</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sarracenia/config.html#parse_count"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sarracenia.config.parse_count" title="Link to this definition"></a></dt>
<dd><p>number argument accepts k,m,g suffix with i and b to use base 2 ) and +-
return value is integer.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="sarracenia.config.parse_float">
<span class="sig-prename descclassname"><span class="pre">sarracenia.config.</span></span><span class="sig-name descname"><span class="pre">parse_float</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cstr</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sarracenia/config.html#parse_float"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sarracenia.config.parse_float" title="Link to this definition"></a></dt>
<dd><p>like parse_count, numeric argument accepts k,m,g suffix and +-.
below 1000, return a decimal number with 3 digits max.</p>
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="sarracenia.config.str_options">
<span class="sig-prename descclassname"><span class="pre">sarracenia.config.</span></span><span class="sig-name descname"><span class="pre">str_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['action',</span> <span class="pre">'admin',</span> <span class="pre">'baseDir',</span> <span class="pre">'broker',</span> <span class="pre">'cluster',</span> <span class="pre">'directory',</span> <span class="pre">'exchange',</span> <span class="pre">'exchange_suffix',</span> <span class="pre">'feeder',</span> <span class="pre">'filename',</span> <span class="pre">'flatten',</span> <span class="pre">'flowMain',</span> <span class="pre">'header',</span> <span class="pre">'hostname',</span> <span class="pre">'identity',</span> <span class="pre">'inlineEncoding',</span> <span class="pre">'logFormat',</span> <span class="pre">'logLevel',</span> <span class="pre">'pollUrl',</span> <span class="pre">'post_baseUrl',</span> <span class="pre">'post_baseDir',</span> <span class="pre">'post_broker',</span> <span class="pre">'post_exchange',</span> <span class="pre">'post_exchangeSuffix',</span> <span class="pre">'post_format',</span> <span class="pre">'post_topic',</span> <span class="pre">'queueName',</span> <span class="pre">'sendTo',</span> <span class="pre">'rename',</span> <span class="pre">'report_exchange',</span> <span class="pre">'source',</span> <span class="pre">'strip',</span> <span class="pre">'timezone',</span> <span class="pre">'nodupe_ttl',</span> <span class="pre">'nodupe_driver',</span> <span class="pre">'nodupe_basis',</span> <span class="pre">'tlsRigour',</span> <span class="pre">'topic']</span></em><a class="headerlink" href="#sarracenia.config.str_options" title="Link to this definition"></a></dt>
Expand Down
2 changes: 1 addition & 1 deletion Reference/sr3_options.7.html
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ <h3>OPTION TYPES<a class="headerlink" href="#option-types" title="Link to this h
</dd>
<dt>flag</dt><dd><p>an option that has only True or False values (aka: a boolean value)</p>
</dd>
<dt>float</dt><dd><p>a floating point number.</p>
<dt>float</dt><dd><p>a floating point number (3 decimal places max, numbers &gt; 1000 are integers)</p>
</dd>
<dt>list</dt><dd><p>a list of string values, each succeeding occurrence catenates to the total.
all v2 plugin options are declared of type list.</p>
Expand Down
Loading

0 comments on commit 7f0c8f3

Please sign in to comment.