Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2025-03-04 15:27:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fixed formatting error in doc example

Browse source
This commit is contained in:
Kevin K 2015-03-16 15:10:00 -04:00
parent 418ead0b00
commit 55ce5c5eea
4 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/clap/struct.App.html
View file

@ -105,11 +105,13 @@ to the user when they print version or help and usage information.</p>
.<span class='ident'>version</span>(<span class='string'>&quot;v0.1.24&quot;</span>)
</pre>
</div><h4 id='method.usage' class='method'><a class='stability Unmarked' title='No stability level'></a><code>fn <a href='#method.usage' class='fnname'>usage</a>(self, u: &amp;'static <a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -&gt; <a class='struct' href='../clap/struct.App.html' title='clap::App'>App</a></code></h4>
<div class='docblock'><p>Sets a custom usage string to over-ride the one auto-generated by <code>clap</code>
<em>NOTE:</em> You do not need to specify the &quot;USAGE: &quot; portion, as that will
<div class='docblock'><p>Sets a custom usage string to over-ride the one auto-generated by <code>clap</code></p>
<p><em>NOTE:</em> You do not need to specify the &quot;USAGE: &quot; portion, as that will
still be applied by <code>clap</code>, you only need to specify the portion starting
with the binary name.
<em>NOTE:</em> This will not replace the entire help message, only the portion
with the binary name. </p>
<p><em>NOTE:</em> This will not replace the entire help message, only the portion
showing the usage.</p>
<h1 id="example" class='section-header'><a

2
docs/search-index.js
View file

File diff suppressed because one or more lines are too long

4
docs/src/clap/app.rs/app.rs.html
View file

@ -905,6 +905,8 @@
<span id="863">863</span>
<span id="864">864</span>
<span id="865">865</span>
<span id="866">866</span>
<span id="867">867</span>
</pre><pre class='rust '>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>libc</span>;
@ -1057,9 +1059,11 @@
}
<span class='doccomment'>/// Sets a custom usage string to over-ride the one auto-generated by `clap`</span>
<span class='doccomment'>/// </span>
<span class='doccomment'>/// *NOTE:* You do not need to specify the &quot;USAGE: &quot; portion, as that will </span>
<span class='doccomment'>/// still be applied by `clap`, you only need to specify the portion starting</span>
<span class='doccomment'>/// with the binary name. </span>
<span class='doccomment'>/// </span>
<span class='doccomment'>/// *NOTE:* This will not replace the entire help message, only the portion</span>
<span class='doccomment'>/// showing the usage.</span>
<span class='doccomment'>///</span>

2
src/app.rs
View file

@ -149,9 +149,11 @@ impl App {
}
/// Sets a custom usage string to over-ride the one auto-generated by `clap`
///
/// *NOTE:* You do not need to specify the "USAGE: " portion, as that will
/// still be applied by `clap`, you only need to specify the portion starting
/// with the binary name.
///
/// *NOTE:* This will not replace the entire help message, only the portion
/// showing the usage.
///