← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/HACKING

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-07-20 05:45:55 UTC
  • mfrom: (2635.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070720054555-bffj18ybejmgiv50
(Ian Clatworthy) Clarify use of underscores in HACKING

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/HACKING
529
529
Naming
530
530
------
531
531
 
532
 
Functions, methods or members that are in some sense "private" are given
533
 
a leading underscore prefix.  This is just a hint that code outside the
534
 
implementation should probably not use that interface.
 
532
Functions, methods or members that are "private" to bzrlib are given
 
533
a leading underscore prefix.  Names without a leading underscore are
 
534
public not just across modules but to programmers using bzrlib as an
 
535
API. As a consequence, a leading underscore is appropriate for names
 
536
exposed across modules but that are not to be exposed to bzrlib API
 
537
programmers.
535
538
 
536
539
We prefer class names to be concatenated capital words (``TestCase``)
537
540
and variables, methods and functions to be lowercase words joined by