Changeset 137 for trunk/doc/misc/codeConventions.tex

Timestamp:

Mar 3, 2004, 11:53:57 AM (22 years ago)

Author:

rhl

Message:

Some minor corrections from Paul Price

File:

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

trunk/doc/misc/codeConventions.tex

@@ -263 +263 @@
 same level on the previous line (for emacs users, this means the
 indentation that \code{<tab>} produces. If this isn't helpful to
-the majority of the people writing code for pan-STARRS, we can
+the majority of the people writing code for \PS{}, we can
 be more formal about what this rule means).
 
@@ -276 +276 @@
 \begin{verbatim}
 someFunc(longExpression1, longExpression2, longExpression3, 
-        longExpression4, longExpression5);
+         longExpression4, longExpression5);
  
 var = someFunc1(longExpression1,
                 someFunc2(longExpression2,
-                        longExpression3)); 
+                          longExpression3)); 
 \end{verbatim}
 
@@ -786 +786 @@
 \item Between the local variables in a function and its first statement
 
-\item Before a block (sec. \ref{ImplBlockComments}) or
-  single-line (sec. \ref{SingleLineComment}) comment
-
 \item Between logical sections inside a function to improve readability
 \end{itemize}
@@ -940 +937 @@
 be uppercase with words separated by underscores (\code{_}). In the case of
 system utilities implemented as macros, the names may conform to the
-usual Pan-STARRS conventions (e.g. \code{psAlloc}).
+usual \PS{} conventions (e.g. \code{psAlloc}).
 
 &
@@ -967 +964 @@
 
 Avoid assigning several variables to the same value in a single
-statement, unless the variables are intimately related. Example:
-
-\begin{verbatim}
-fChar = lchar = 'c';                    // AVOID!
-row0 = col0 = 0;                        // OK
+statement, unless the variables are intimately related. Acceptable examples:
+
+\begin{verbatim}
+row0 = col0 = 0;
+sum = sumx = sumy = 0;
 \end{verbatim}
 
@@ -1142 +1139 @@
 
 When defining a function to convert from one type to another, the
-name should be of the form \code{psOldToNew}, e.g.
+name should be of the form \code{psOldToNew}, e.g.\hfil\break
 \code{psEquatorialToEcliptic} (\emph{not} \code{psEquatorial2Ecliptic}).
 
@@ -1148 +1145 @@
 
 Functions that assign to a variable should list that argument
-\textit{first} (i.e. following the pattern of \code{strcpy}):
+\textit{first} (i.e. following the pattern of \code{strcpy}); e.g.
+\begin{verbatim}
+void psAddToVector(restrict psVec *outVec, const restrict psVec *inVec,
+                   int val);
+\end{verbatim}
 
 \subsection{Type Qualifiers (const and restrict)}
@@ -1401 +1402 @@
   \label{dot_emacs}
 
-\textit{This section is provided for your convenience, it is of course
+\textit{This section is provided for your convenience; it is, of course,
 not part of the coding standards.}