[Blotter-commits] r795 - in pkg/FinancialInstrument: R man

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

Author: gsee
Date: 2011-09-26 21:01:26 +0200 (Mon, 26 Sep 2011)
New Revision: 795

Modified:
   pkg/FinancialInstrument/R/instrument.R
   pkg/FinancialInstrument/man/instrument.auto.Rd
Log:
 remove spurious @note in roxygen block

Modified: pkg/FinancialInstrument/R/instrument.R
===================================================================
--- pkg/FinancialInstrument/R/instrument.R	2011-09-26 18:53:50 UTC (rev 794)
+++ pkg/FinancialInstrument/R/instrument.R	2011-09-26 19:01:26 UTC (rev 795)
@@ -638,7 +638,7 @@
 #' Given a name, this function will attempt to create
 #' an instrument of the appropriate type.
 #'
-#' @note If \code{currency} is not already defined, it will be defined (unless it is not 3 uppercase characters).
+#' If \code{currency} is not already defined, it will be defined (unless it is not 3 uppercase characters).
 #' The default value for \code{currency} is \dQuote{USD}.  If you do not provide a value for \code{currency}, 
 #' \dQuote{USD} will be defined and used to create the instrument.  
 #'

Modified: pkg/FinancialInstrument/man/instrument.auto.Rd
===================================================================
--- pkg/FinancialInstrument/man/instrument.auto.Rd	2011-09-26 18:53:50 UTC (rev 794)
+++ pkg/FinancialInstrument/man/instrument.auto.Rd	2011-09-26 19:01:26 UTC (rev 795)
@@ -30,7 +30,7 @@
   Given a name, this function will attempt to create an
   instrument of the appropriate type.
 }
-\note{
+\details{
   If \code{currency} is not already defined, it will be
   defined (unless it is not 3 uppercase characters). The
   default value for \code{currency} is \dQuote{USD}.  If
@@ -64,7 +64,8 @@
   but a lot of things would be filled in as if it were a
   valid series instrument (e.g. \sQuote{expires},
   \sQuote{strike}, \sQuote{suffix_id}, etc.)
-
+}
+\note{
   This is not intended to be used to create instruments of
   type \code{stock}, \code{future}, \code{option}, or
   \code{bond} although it may be updated in the future.