Skip to content

Commit d798e00

Browse files
kud1inghuonw
authored andcommitted
Enclose code in documentation in backticks
1 parent 930f779 commit d798e00

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/libextra/getopts.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
//! Simple getopt alternative.
1212
//!
13-
//! Construct a vector of options, either by using reqopt, optopt, and optflag
14-
//! or by building them from components yourself, and pass them to getopts,
15-
//! along with a vector of actual arguments (not including argv[0]). You'll
13+
//! Construct a vector of options, either by using `reqopt`, `optopt`, and `optflag`
14+
//! or by building them from components yourself, and pass them to `getopts`,
15+
//! along with a vector of actual arguments (not including `argv[0]`). You'll
1616
//! either get a failure code back, or a match. You'll have to verify whether
17-
//! the amount of 'free' arguments in the match is what you expect. Use opt_*
17+
//! the amount of 'free' arguments in the match is what you expect. Use `opt_*`
1818
//! accessors to get argument values out of the matches object.
1919
//!
2020
//! Single-character options are expected to appear on the command line with a
@@ -27,7 +27,7 @@
2727
//!
2828
//! The following example shows simple command line parsing for an application
2929
//! that requires an input file to be specified, accepts an optional output
30-
//! file name following -o, and accepts both -h and --help as optional flags.
30+
//! file name following `-o`, and accepts both `-h` and `--help` as optional flags.
3131
//!
3232
//! ~~~{.rust}
3333
//! exter mod extra;

0 commit comments

Comments
 (0)