← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/HACKING.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-12-12 01:24:50 UTC
  • mfrom: (3882.4.2 doc-hacking)
  • Revision ID: pqm@pqm.ubuntu.com-20081212012450-3gw576prpztxziib
(mbp) Developer documentation about when to add new exception classes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/HACKING.txt
886
886
that exception specifically, or when it needs a substantially different
887
887
format string.
888
888
 
 
889
#. If it is something that a caller can recover from, a custom exception
 
890
   is reasonable. 
 
891
 
 
892
#. If it is a data consistency issue, using a builtin like
 
893
   ``ValueError``/``TypeError`` is reasonable. 
 
894
 
 
895
#. If it is a programmer error (using an api incorrectly)
 
896
   ``AssertionError`` is reasonable. 
 
897
 
 
898
#. Otherwise, use ``BzrError`` or ``InternalBzrError``.
 
899
 
889
900
Exception strings should start with a capital letter and should not have a
890
901
final fullstop.  If long, they may contain newlines to break the text.
891
902