On Sun, Sep 26, 2010 at 20:20, Todd B. Sanders <[email protected]> wrote: > I'd like to establish some standards for the way we document --help for our > client tools. I am proposing the following simple rules: > > 1. all lower case, always. > 2. semi-colons to separate multiple thoughts. > 3. no periods. > 4. no abbreviations. > > For example, this will change our current --help from: > > --relativepath=RELATIVEPATH Relative path where the repo is stored and > exposed to > > clients. This defaults to feed path if not > specified. > > > To: > > --relativepath=RELATIVEPATH relative path where the repository is stored > and exposed to > > clients; this defaults to feed path if not > specified > > > Please yell if you object to any of this. I'll be modifying the current > implementation to conform to these new rules. >
I would like to nicely yell. The ; does not show up very large on this RHEL box I am using at the moment so the two sentences ran into one. I prefer capitals. However if there is a precedent in yum or cobbler help for that.. I guess it would be better to use that. -- Stephen J Smoogen. “The core skill of innovators is error recovery, not failure avoidance.” Randy Nelson, President of Pixar University. "We have a strategic plan. It's called doing things."" — Herb Kelleher, founder Southwest Airlines _______________________________________________ Pulp-list mailing list [email protected] https://www.redhat.com/mailman/listinfo/pulp-list
