Changeset 3925

Timestamp:

May 13, 2005, 11:38:44 AM (21 years ago)

Author:

Paul Price

Message:

Adding blurb on boolean return values.

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (3 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.213 2005-05-05 03:21:42 jhoblitt Exp $
+%%% $Id: psLibSDRS.tex,v 1.214 2005-05-13 21:38:44 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -183 +183 @@
 employed where necessary, and where the assumption will hold.
 
+\subsection{Return values}
+
+In some cases, we have defined functions that return a boolean value.
+It is intended that (unless otherwise specified), the function returns
+\code{true} if there was no error, and returns \code{false} in the
+event of an error.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -215 +222 @@
 
 \code{timeConfig} specifies the filename of the configuration file
-for \code{psTime} metadata.
+for \code{psTime} metadata
 
 \subsection{Finalization}