← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/plugin-api.txt

  • Committer: Martin
  • Date: 2010-04-16 12:59:03 UTC
  • mto: (5177.1.1 integration2)
  • mto: This revision was merged to the branch mainline in revision 5179.
  • Revision ID: gzlist@googlemail.com-20100416125903-yjm9d5uc7l8ilxpf
Catch a couple of missed plugin module docstrings, note need for assignment to __doc__ in developer documentation and NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/plugin-api.txt
186
186
short complete sentence summarizing the plugin.  The full docstring is
187
187
shown by ``bzr help PLUGIN_NAME``.
188
188
 
189
 
Remember that to be effective, the module docstring must be the first
190
 
statement in the file.  It may come after comments but it must be before
191
 
any import statements.
 
189
This is a user-visible docstring so should be prefixed with ``__doc__ =``
 
190
to ensure help works under ``python -OO`` with docstrings stripped.
192
191
 
193
192
API version
194
193
-----------