[Roxygen-commits] r199 - pkg/inst/doc

[noreply at r-forge.r-project.org]

Author: pcd
Date: 2008-08-28 02:34:23 +0200 (Thu, 28 Aug 2008)
New Revision: 199

Modified:
   pkg/inst/doc/roxygen.Rnw
Log:
parenthetical lines


Modified: pkg/inst/doc/roxygen.Rnw
===================================================================
--- pkg/inst/doc/roxygen.Rnw	2008-08-27 18:39:23 UTC (rev 198)
+++ pkg/inst/doc/roxygen.Rnw	2008-08-28 00:34:23 UTC (rev 199)
@@ -123,7 +123,7 @@
 \texttt{@param <variable> <description>}. Similarly, the return value
 must be documented with \texttt{@return <description>} (lines 9-10).
 
-Notice \texttt{@callGraphPrimitives} on line 11: it creates a call
+Notice \texttt{@callGraphPrimitives} (line 11): it creates a call
 graph at the default depth similar to figure \ref{fermat-test},
 including primitive functions; \texttt{@callGraph}, on the other hand,
 would exclude primitive functions.
@@ -143,12 +143,13 @@
         {pseudoprime}
 
 Notice the header in \texttt{pseudoprime.R} (fig. \ref{pseudoprime})
-terminated by \texttt{roxygen()}; `\texttt{@include fermat.R}' signals
-that \texttt{fermat.R} should be loaded before \texttt{pseudoprime.R}.
-\texttt{DESCRIPTION} will be updated accordingly.
+terminated by \texttt{roxygen()}; \texttt{@include fermat.R} (line 1)
+signals that \texttt{fermat.R} should be loaded before
+\texttt{pseudoprime.R}.  The collate roclet will update
+\texttt{DESCRIPTION} accordingly.
 
-\texttt{@export} in line 15 signifies that \texttt{is.pseudoprime}
-will be added to an export directive in \texttt{NAMESPACE}.
+\texttt{@export} (line 15) signifies that \texttt{is.pseudoprime} will
+be added to an export directive in \texttt{NAMESPACE}.
 
 \subsection{Running \Roxygen{}}