← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to HACKING

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
133
133
Documentation
134
134
=============
135
135
 
136
 
If you change the behaviour of a command, please update its docstring
137
 
in bzrlib/commands.py.  This is displayed by the 'bzr help' command.
 
136
When you change bzrlib, please update the relevant documentation for the
 
137
change you made: Changes to commands should update their help, and
 
138
possibly end user tutorials; changes to the core library should be
 
139
reflected in API documentation.
 
140
 
 
141
Commands
 
142
--------
 
143
 
 
144
The docstring of a command is used by ``bzr help`` to generate help output
 
145
for the command. The list 'takes_options' attribute on a command is used by
 
146
``bzr help`` to document the options for the command - the command
 
147
docstring does not need to document them. Finally, the '_see_also'
 
148
attribute on a command can be used to reference other related help topics.
138
149
 
139
150
NEWS file
140
151
---------