Changeset 2541

Timestamp:

Nov 30, 2004, 12:42:30 PM (22 years ago)

Author:

jhoblitt

Message:

add conformance, misc corrections

File:

• trunk/doc/misc/perlCodeConventions.tex (modified) (3 diffs)

trunk/doc/misc/perlCodeConventions.tex

@@ -1 @@
-%%% $Id: perlCodeConventions.tex,v 1.40 2004-11-30 22:30:49 jhoblitt Exp $
+%%% $Id: perlCodeConventions.tex,v 1.41 2004-11-30 22:42:30 jhoblitt Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -85 +85 @@
 This document is intended to be relevant to Perl 5.8.0 or later.
 
+\subsection{Conformance}
+
+If any of the conventions estiblished in this document conflict with source
+code that has been formated by \code{perltidy} (see \S\ref{perltidy}), the
+formatting as output by \code{perltidy} will be considered to be in compliance
+with the Perl Code Standards.
+
 \subsection{To whom should I Complain?}
 
-While Robert didn't actually write this document he would enjoy receiving any
-complaints it may generate.
+While Robert Lupton didn't actually write this document he would enjoy
+receiving any complaints or comments it may generate.
 
 \code{<rhl@astro.princeton.edu>}.
@@ -443 +450 @@
 \end{verbatim}
 
-\emph{\code{perltidy} is incapable of formatting trailing comments in this
-style.  It will force trailing comments to be 4 spaces to the right of the last
-character in any statement on the line.  However, it will add additional spaces
-to cause trailing comments in adjoining lines to be vertically aligned.  Until
-such time as \code{perltidy} can following this convention or a replacement
-tool is located, code as formatted by \code{perltidy} will be considered
-acceptable.}
+\emph{\code{perltidy}(\S\ref{perltidy}) is incapable of formatting trailing
+comments in this style.  It will force trailing comments to be 4 spaces to the
+right of the last character in any statement on the line.  However, it will add
+additional spaces to cause trailing comments in adjoining lines to be
+vertically aligned.  Until such time as \code{perltidy} can following this
+convention or a replacement tool is located, code as formatted by
+\code{perltidy} will be considered acceptable.}
 
 \subsection{API Comments}