← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/HACKING

  • Committer: Martin Pool
  • Date: 2007-07-10 10:20:27 UTC
  • mto: This revision was merged to the branch mainline in revision 2599.
  • Revision ID: mbp@sourcefrog.net-20070710102027-2os88re33c57m522
Add test for and documentation of option style, fix up existing options to comply

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/HACKING
693
693
should be only in the command-line tool.
694
694
 
695
695
 
 
696
 
 
697
Displaying help
 
698
===============
 
699
 
 
700
Bazaar has online help for various topics through ``bzr help COMMAND`` or
 
701
equivalently ``bzr command -h``.  We also have help on command options,
 
702
and on other help topics.  (See ``help_topics.py``.)
 
703
 
 
704
As for python docstrings, the first paragraph should be a single-sentence
 
705
synopsis of the command.
 
706
 
 
707
The help for options should be one or more proper sentences, starting with
 
708
a capital letter and finishing with a full stop (period).
 
709
 
 
710
All help messages and documentation should have two spaces between
 
711
sentences.
 
712
 
 
713
 
696
714
Writing tests
697
715
=============
698
716