Changeset 1650

Timestamp:

Aug 27, 2004, 1:45:05 PM (22 years ago)

Author:

Paul Price

Message:

Added clarification that ps and p_ps are only for names visible at
global scope.

File:

• trunk/doc/misc/codeConventions.tex (modified) (2 diffs)

trunk/doc/misc/codeConventions.tex

@@ -1 @@
-%%% $Id: codeConventions.tex,v 1.15 2004-04-23 21:57:43 eugene Exp $
+%%% $Id: codeConventions.tex,v 1.16 2004-08-27 23:45:05 price Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -971 +971 @@
 confuse this use of \code{static} with its usage to make
 auto-variables within a function persistent.
+
+A name (whether of a variable, a function, or a type) shall start
+\code{ps} (or \code{p_ps}) if and only if it is visible at global
+scope.  The distinction is that \code{p_ps} names are not part of the
+documented APIs, but need to be exposed for some reason.
 
 \subsection{Constants}