about summary refs log tree commit diff
path: root/src/libextra
diff options
context:
space:
mode:
authorkud1ing <github@kudling.de>2013-09-26 07:51:19 +0200
committerHuon Wilson <dbau.pp+github@gmail.com>2013-09-26 23:15:42 +1000
commitd798e00337e72d5036a5c3cfd463c6ebb30d83d2 (patch)
treeddfcda1cf60aef55be5a94c430023811b0877385 /src/libextra
parent930f7790fbad87f1ddf26a34b089622bc8a742c8 (diff)
downloadrust-d798e00337e72d5036a5c3cfd463c6ebb30d83d2.tar.gz
rust-d798e00337e72d5036a5c3cfd463c6ebb30d83d2.zip
Enclose code in documentation in backticks
Diffstat (limited to 'src/libextra')
-rw-r--r--src/libextra/getopts.rs10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/libextra/getopts.rs b/src/libextra/getopts.rs
index f73c34224ee..e6ac1deeb62 100644
--- a/src/libextra/getopts.rs
+++ b/src/libextra/getopts.rs
@@ -10,11 +10,11 @@
 
 //! Simple getopt alternative.
 //!
-//! Construct a vector of options, either by using reqopt, optopt, and optflag
-//! or by building them from components yourself, and pass them to getopts,
-//! along with a vector of actual arguments (not including argv[0]). You'll
+//! Construct a vector of options, either by using `reqopt`, `optopt`, and `optflag`
+//! or by building them from components yourself, and pass them to `getopts`,
+//! along with a vector of actual arguments (not including `argv[0]`). You'll
 //! either get a failure code back, or a match. You'll have to verify whether
-//! the amount of 'free' arguments in the match is what you expect. Use opt_*
+//! the amount of 'free' arguments in the match is what you expect. Use `opt_*`
 //! accessors to get argument values out of the matches object.
 //!
 //! Single-character options are expected to appear on the command line with a
@@ -27,7 +27,7 @@
 //!
 //! The following example shows simple command line parsing for an application
 //! that requires an input file to be specified, accepts an optional output
-//! file name following -o, and accepts both -h and --help as optional flags.
+//! file name following `-o`, and accepts both `-h` and `--help` as optional flags.
 //!
 //! ~~~{.rust}
 //! exter mod extra;