Rev 2636: (Ian Clatworthy) Clarify use of underscores in HACKING in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

[Canonical.com Patch Queue Manager]

At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 2636
revision-id: pqm at pqm.ubuntu.com-20070720054555-bffj18ybejmgiv50
parent: pqm at pqm.ubuntu.com-20070720035545-uh4yjypen2ux6z8s
parent: ian.clatworthy at internode.on.net-20070720041438-bxsgat12jjuc2pi2
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Fri 2007-07-20 06:45:55 +0100
message:
  (Ian Clatworthy) Clarify use of underscores in HACKING
modified:
  doc/developers/HACKING         HACKING-20050805200004-2a5dc975d870f78c
    ------------------------------------------------------------
    revno: 2635.1.1
    merged: ian.clatworthy at internode.on.net-20070720041438-bxsgat12jjuc2pi2
    parent: pqm at pqm.ubuntu.com-20070720035545-uh4yjypen2ux6z8s
    parent: ian.clatworthy at internode.on.net-20070718063828-us15mjk42ixk3rfy
    committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
    branch nick: ianc-integration
    timestamp: Fri 2007-07-20 14:14:38 +1000
    message:
      (Ian Clatworthy) Clarify use of underscores in HACKING
    ------------------------------------------------------------
    revno: 2625.3.1
    merged: ian.clatworthy at internode.on.net-20070718063828-us15mjk42ixk3rfy
    parent: pqm at pqm.ubuntu.com-20070717180333-5smmeduk2q3sbzvw
    committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
    branch nick: bzr.HACKING-visibility
    timestamp: Wed 2007-07-18 16:38:28 +1000
    message:
      Clarify the use of underscore in the naming convention
=== modified file 'doc/developers/HACKING'
--- a/doc/developers/HACKING	2007-07-12 11:44:08 +0000
+++ b/doc/developers/HACKING	2007-07-18 06:38:28 +0000
@@ -529,9 +529,12 @@
 Naming
 ------
 
-Functions, methods or members that are in some sense "private" are given
-a leading underscore prefix.  This is just a hint that code outside the
-implementation should probably not use that interface.
+Functions, methods or members that are "private" to bzrlib are given
+a leading underscore prefix.  Names without a leading underscore are
+public not just across modules but to programmers using bzrlib as an
+API. As a consequence, a leading underscore is appropriate for names
+exposed across modules but that are not to be exposed to bzrlib API
+programmers.
 
 We prefer class names to be concatenated capital words (``TestCase``)
 and variables, methods and functions to be lowercase words joined by