[svnbook commit] r2721 - trunk/src/en
noreply at red-bean.com
Tue Feb 27 14:44:23 CST 2007
Date: Tue Feb 27 14:44:23 2007
New Revision: 2721
Amend the rules for subcommand option descriptions.
--- trunk/src/en/HACKING (original)
+++ trunk/src/en/HACKING Tue Feb 27 14:44:23 2007
@@ -120,11 +120,14 @@
- Option names:
- - For prose, always identify an option by *both* its long and
- short name, e.g. "use the --revision (-r) option to do blah..."
- - For examples, use the short version, so as to be more realistic
- and get users comfortable with the abbreviations.
+ - By default, identify an option by *both* its long and
+ short name in the prose, e.g. "use the --revision (-r) option to
+ do blah..."
+ - For examples (those in <screen> tags, as we as those embedded in
+ the prose with <command> tags), use the short version, so as to
+ be more realistic and get users comfortable with the
More information about the svnbook-dev