doc/file.README.html in term_utils-0.3.2 vs doc/file.README.html in term_utils-0.4.0
- old
+ new
@@ -4,19 +4,19 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
- — Documentation by YARD 0.9.20
+ — Documentation by YARD 0.9.25
</title>
- <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
- <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
pathId = "README";
relpath = '';
</script>
@@ -56,32 +56,70 @@
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'>
-<h1 id="label-term_utils">term_utils</h1>
+<h1 id="term_utils">term_utils</h1>
-<p>Terminal utilities for ruby.</p>
+<h2 id="purpose">Purpose</h2>
-<h2 id="label-Purpose">Purpose</h2>
+<p>Provides utilities like argument parsing, table formatting and file finding.</p>
-<p>Provides terminal utilities like table formatting.</p>
+<h2 id="getting_started">Getting Started</h2>
-<h2 id="label-Content">Content</h2>
+<p>Install term_utils at the command prompt:</p>
-<h3 id="label-Table+formatting">Table formatting</h3>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_term_utils'>term_utils</span></code></pre>
+<p>Require term_utils in the source file:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>term_utils</span><span class='tstring_end'>'</span></span></code></pre>
+
+<h2 id="content">Content</h2>
+
+<h3 id="argument_parsing">Argument Parsing</h3>
+
+<p>Exmaple:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>term_utils/ap</span><span class='tstring_end'>'</span></span>
+<span class='id identifier rubyid_syntax'>syntax</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="TermUtils/AP.html" title="TermUtils::AP (module)">AP</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_syntax'><span class='object_link'><a href="TermUtils/AP.html#create_syntax-class_method" title="TermUtils::AP.create_syntax (method)">create_syntax</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span>
+ <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_define_parameter'>define_parameter</span> <span class='symbol'>:limit</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span>
+ <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_define_flag'>define_flag</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-l</span><span class='tstring_end'>'</span></span>
+ <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_define_article'>define_article</span>
+ <span class='kw'>end</span>
+ <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_define_parameter'>define_parameter</span> <span class='symbol'>:path</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span>
+ <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_max_occurs'>max_occurs</span> <span class='op'>=</span> <span class='kw'>nil</span>
+ <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_define_article'>define_article</span>
+ <span class='kw'>end</span>
+<span class='kw'>end</span>
+<span class='id identifier rubyid_limit'>limit</span> <span class='op'>=</span> <span class='kw'>nil</span>
+<span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+<span class='const'><span class='object_link'><a href="TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="TermUtils/AP.html" title="TermUtils::AP (module)">AP</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_arguments'><span class='object_link'><a href="TermUtils/AP.html#parse_arguments-class_method" title="TermUtils::AP.parse_arguments (method)">parse_arguments</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_syntax'>syntax</span><span class='comma'>,</span> <span class='const'>ARGV</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_on'>on</span><span class='op'>|</span>
+ <span class='id identifier rubyid_on'>on</span><span class='period'>.</span><span class='id identifier rubyid_parameter'>parameter</span> <span class='symbol'>:limit</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span>
+ <span class='id identifier rubyid_limit'>limit</span> <span class='op'>=</span> <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
+ <span class='kw'>end</span>
+ <span class='id identifier rubyid_on'>on</span><span class='period'>.</span><span class='id identifier rubyid_parameter'>parameter</span> <span class='symbol'>:path</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span>
+ <span class='id identifier rubyid_paths'>paths</span> <span class='op'><<</span> <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
+ <span class='kw'>end</span>
+<span class='kw'>end</span>
+<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>limit: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_limit'>limit</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
+<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>paths:</span><span class='tstring_end'>"</span></span>
+<span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_p'>p</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span></code></pre>
+
+<p>See the <a href="manual/ARGUMENT_PARSING.md">manual</a> for more details.</p>
+
+<h3 id="table_formatting">Table Formatting</h3>
+
<p>Take the following table:</p>
-<pre class="code ruby"><code class="ruby"> id string8 string16
- ---- -------- ----------------
- 1 Fiat Lux Fiat Lux
- 2 Alea ... Alea jacta est
- 3 Audac... Audaces fortuna juvat
- ---- -------- ----------------
- id string8 string16
-</code></pre>
+<pre class="code ruby"><code class="ruby"> <span class='id identifier rubyid_id'>id</span> <span class='id identifier rubyid_string8'>string8</span> <span class='id identifier rubyid_string16'>string16</span></code></pre>
+<hr />
+<pre class="code ruby"><code class="ruby"> 1 Fiat Lux Fiat Lux
+ 2 Alea ... Alea jacta est
+ 3 Audac... Audaces fortuna juvat</code></pre>
+<hr />
+<pre class="code ruby"><code class="ruby"> <span class='id identifier rubyid_id'>id</span> <span class='id identifier rubyid_string8'>string8</span> <span class='id identifier rubyid_string16'>string16</span></code></pre>
<p>You can produce it with the following code:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>term_utils/tab</span><span class='tstring_end'>'</span></span>
@@ -104,33 +142,28 @@
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span> <span class='id identifier rubyid_d'>d</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_separator'>separator</span>
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_header'>header</span>
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_line'>line</span>
-<span class='kw'>end</span>
-</code></pre>
+<span class='kw'>end</span></code></pre>
-<h3 id="label-Argument+Parsing">Argument Parsing</h3>
+<h3 id="file_finding">File Finding</h3>
-<p>The Argument Parsing module provides a way to parse command line arguments.</p>
+<p>The File Finding module provides a way to query the filesystem.</p>
-<p>See Samples.</p>
+<h2 id="version_history">Version History</h2>
-<h3 id="label-File+Finder">File Finder</h3>
+<p><a href="CHANGELOG.md">CHANGELOG</a></p>
-<p>The File Finder module provides a way to query the filesystem.</p>
+<h2 id="license">License</h2>
-<p>See the samples.</p>
-
-<h2 id="label-License">License</h2>
-
<p>GPL-3.0-only.</p>
</div></div>
<div id="footer">
- Generated on Fri Feb 7 18:54:38 2020 by
+ Generated on Sun Aug 2 18:35:09 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.9.20 (ruby-2.6.5).
+ 0.9.25 (ruby-2.6.5).
</div>
</div>
</body>
</html>
\ No newline at end of file