[Rprotobuf-commits] r587 - pkg/vignettes

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

Author: murray
Date: 2013-12-19 08:55:14 +0100 (Thu, 19 Dec 2013)
New Revision: 587

Modified:
   pkg/vignettes/RProtoBuf-intro.Rnw
Log:
Address some TODOs, add a blurb about better documenting extensions in
the plans for future releases.



Modified: pkg/vignettes/RProtoBuf-intro.Rnw
===================================================================
--- pkg/vignettes/RProtoBuf-intro.Rnw	2013-12-19 07:44:37 UTC (rev 586)
+++ pkg/vignettes/RProtoBuf-intro.Rnw	2013-12-19 07:55:14 UTC (rev 587)
@@ -1163,12 +1163,10 @@
 \texttt{label} & \ref{fielddescriptor-method-label} & Gets the label of a field (optional, required, or repeated).\\
 \texttt{is\_repeated} & \ref{fielddescriptor-method-isrepeated} & Return TRUE if this field is repeated.\\
 \texttt{is\_required} & \ref{fielddescriptor-method-isrequired} & Return TRUE if this field is required.\\
-\texttt{is\_optional} & \ref{fielddescriptor-method-isoptional} & Return TRUE if htis field is optional.\\
-\texttt{has\_default\_value} & \ref{fielddescriptor-method-hasdefaultvalue} &
-Return TRUE if this field has a default value.\\
+\texttt{is\_optional} & \ref{fielddescriptor-method-isoptional} & Return TRUE if this field is optional.\\
+\texttt{has\_default\_value} & \ref{fielddescriptor-method-hasdefaultvalue} & Return TRUE if this field has a default value.\\
 \texttt{default\_value} & \ref{fielddescriptor-method-defaultvalue} &
 Return the default value.\\
-\texttt{is\_optional} & \ref{fielddescriptor-method-isoptional} & Return TRUE if htis field is optional.\\
 \texttt{message\_type} & \ref{fielddescriptor-method-messagetype} & Return the message type if this is a message type field.\\
 \texttt{enum\_type} & \ref{fielddescriptor-method-enumtype} & Return the enum type if this is an enum type field.\\
 \hline
@@ -1328,9 +1326,6 @@
 tutorial.Person$id$is_optional()
 @
 
-
-\texttt{has\_default\_value} & \ref{fielddescriptor-method-hasdefaultvalue} &
-Return TRUE if this field has a default value.\\
 \subsubsection{has\_default\_value}
 \label{fielddescriptor-method-hasdefaultvalue}
 
@@ -1342,20 +1337,16 @@
 has_default_value(tutorial.Person$PhoneNumber$number)
 @
 
-\texttt{default\_value} & \ref{fielddescriptor-method-defaultvalue} &
-Return the default value.\\
-\subsubsection{is\_optional}
-\label{fielddescriptor-method-isoptional}
+\subsubsection{default\_value}
+\label{fielddescriptor-method-defaultvalue}
 
-The \texttt{is\_optional} method returns TRUE if this field is optional.
+The \texttt{default\_value} method returns the default value of a field.
 
 <<>>=
-is_optional( tutorial.Person$id )
-tutorial.Person$id$is_optional()
+default_value( tutorial.Person$PhoneNumber$type )
+default_value( tutorial.Person$PhoneNumber$number )
 @
 
-
-
 \subsubsection{message\_type}
 \label{fielddescriptor-method-messagetype}
 
@@ -1798,12 +1789,18 @@
 \subsection{service descriptors}
 \label{subsec-ServiceDescriptor}
 
-TODO: add content or remove?
+Not fully implemented.  Needs to be connected to a concrete RPC
+implementation.  The Google Protocol Buffers C++ open-source library
+does not include an RPC implementation, but this can be connected
+easily to others.
 
 \subsection{method descriptors}
 \label{subsec-MethodDescriptor}
 
-TODO: add content or remove?
+Not fully implemented.  Needs to be connected to a concrete RPC
+implementation.  The Google Protocol Buffers C++ open-source library
+does not include an RPC implementation, but this can be connected
+easily to others.
 
 \section{Utilities}
 
@@ -2022,6 +2019,11 @@
 and client code as well, probably based on the functionality
 of the \texttt{Rserve} package.
 
+Extensions have been implemented in RProtoBuf and have been
+extensively used and tested, but they are not currently described in
+this vignette.  Additional examples and documentation are needed for
+extensions.
+
 % \section{Troubleshouting}
 
 \section{Acknowledgments}