← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/HACKING.txt

  • Committer: Vincent Ladeuil
  • Date: 2010-04-23 08:51:52 UTC
  • mfrom: (5131.2.6 support_OO_flag)
  • mto: This revision was merged to the branch mainline in revision 5179.
  • Revision ID: v.ladeuil+lp@free.fr-20100423085152-uoewc1vnkwqhw0pj
Manually assign docstrings to command objects, so that they work with python -OO

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/HACKING.txt
1053
1053
and on other help topics.  (See ``help_topics.py``.)
1054
1054
 
1055
1055
As for python docstrings, the first paragraph should be a single-sentence
1056
 
synopsis of the command.
 
1056
synopsis of the command. These are user-visible and should be prefixed with
 
1057
``__doc__ =`` so help works under ``python -OO`` with docstrings stripped.
1057
1058
 
1058
1059
The help for options should be one or more proper sentences, starting with
1059
1060
a capital letter and finishing with a full stop (period).