← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/HACKING.txt

  • Committer: Mark Hammond
  • Date: 2008-12-28 05:21:23 UTC
  • mfrom: (3920 +trunk)
  • mto: (3932.1.1 prepare-1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mhammond@skippinet.com.au-20081228052123-f78xs5sbdkotshwf
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/HACKING.txt
249
249
 
250
250
* the reason **why** you're making this change
251
251
 
252
 
* **how** this change acheives this purpose
 
252
* **how** this change achieves this purpose
253
253
 
254
254
* anything else you may have fixed in passing 
255
255
 
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