[Rprotobuf-commits] r469 - in pkg: . inst man

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

Author: edd
Date: 2012-08-09 04:52:15 +0200 (Thu, 09 Aug 2012)
New Revision: 469

Modified:
   pkg/ChangeLog
   pkg/inst/NEWS.Rd
   pkg/man/add.Rd
Log:
one last patch by Murray


Modified: pkg/ChangeLog
===================================================================
--- pkg/ChangeLog	2012-08-09 02:20:40 UTC (rev 468)
+++ pkg/ChangeLog	2012-08-09 02:52:15 UTC (rev 469)
@@ -11,6 +11,9 @@
 	protocol buffers (with missing required fields)
 	* inst/unitTests/runit.serialize.R: Added tests for this
 
+	* /man/add.Rd: Add patch by Murray for stylistic improvement and
+	added examples
+	
 	* inst/NEWS.Rd: Converted NEWS file to .Rd format
 
 	* DESCRIPTION: Changed Maintainer: to single person per CRAN Policy

Modified: pkg/inst/NEWS.Rd
===================================================================
--- pkg/inst/NEWS.Rd	2012-08-09 02:20:40 UTC (rev 468)
+++ pkg/inst/NEWS.Rd	2012-08-09 02:52:15 UTC (rev 469)
@@ -10,6 +10,8 @@
       also add new unit test for this
       \item test a a protocol buffer for missing required fields before
       serializing it, also add a unit test
+      \item add a small stylistic fix and examples to the 'add.Rd'
+      manual page 
     }
     \item Moved inst/doc/ to vignettes/ per newer CRAN Policy
   }

Modified: pkg/man/add.Rd
===================================================================
--- pkg/man/add.Rd	2012-08-09 02:20:40 UTC (rev 468)
+++ pkg/man/add.Rd	2012-08-09 02:52:15 UTC (rev 469)
@@ -5,11 +5,20 @@
 \alias{add,Message-method}
 \title{add elements of a repeated field of a message}
 \description{
-add elements to a repeated field of a message. 
+Add elements to a repeated field of a message.
 }
 \section{Methods}{
 \describe{
 \item{\code{signature(object = "Message")}}{add elements to a repeated field of a message}
 }}
+\examples{
+unitest.proto.file <- system.file("unitTests", "data", "unittest.proto",
+				  package = "RProtoBuf" )
+readProtoFiles(file = unitest.proto.file)
+
+test <- new(protobuf_unittest.TestAllTypes)
+test$add("repeated_int32", 1)
+test$add("repeated_int32", 2:10)
+test$repeated_int32
+}
 \keyword{methods}
-