update man pages / version bump

sequoiar · Sep 29, 2011 · 7641beb · 7641beb
1 parent ea9c459
commit 7641beb
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 24 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: rzmq
 Title: R binding for zmq (http://www.zeromq.org/)
-Version: 0.1.0
+Version: 0.5.0
 Maintainer: Whit Armstrong <armstrong.whit@gmail.com>
 Author: Whit Armstrong <armstrong.whit@gmail.com>
 Description: R binding for zmq

diff --git a/man/create.sink.Rd b/man/create.sink.Rd
@@ -14,10 +14,11 @@
 create.sink(address, num_items)
 get.sink.results(sink)
 }
-%- maybe also 'usage' for other objects documented here.
 \arguments{
   \item{address}{the transport endpoint for the remote sink server.}
-  \item{num_items}{the number of items to indicate the remote job has completed.}
+  \item{num_items}{the number of items to indicate the remote job has
+    completed.}
+  \item{sink}{the sink object.}
 }
 \value{
   create.sink returns a sink object

diff --git a/man/init.context.Rd b/man/init.context.Rd
@@ -2,10 +2,10 @@
 \alias{init.context}
 \alias{init.socket}
 \title{
-initailize zmq context and zmq socket
+  initailize zmq context and zmq socket
 }
 \description{
-initailize zmq context and zmq socket for to be used for further zmq operations.
+  initailize zmq context and zmq socket for to be used for further zmq operations.
 }
 \usage{
 init.context()
@@ -16,19 +16,19 @@ init.socket(context, socket.type)
   \item{context}{returns a zmq context object.}
   \item{socket.type}{ The ZMQ socket type requested
     e.g. ZMQ_REQ,ZMQ_REP,ZMQ_PULL,ZMQ_PUSH, etc.}
-
+}
 \value{
-  \code{init.context} returns a zmq context object.
-  \code{init.socket} returns a zmq socket object.
+  \code{init.context}{ returns a zmq context object.}
+  \code{init.socket}{returns a zmq socket object.}
 }
 \references{
-http://www.zeromq.org
-http://api.zeromq.org
-http://zguide.zeromq.org/page:all
+  http://www.zeromq.org
+  http://api.zeromq.org
+  http://zguide.zeromq.org/page:all
 }
 \author{
-ZMQ was written by Martin Sustrik <sustrik@250bpm.com> and Martin Lucina <mato@kotelna.sk>.
-rzmq was written by Whit Armstrong.
+  ZMQ was written by Martin Sustrik <sustrik@250bpm.com> and Martin Lucina <mato@kotelna.sk>.
+  rzmq was written by Whit Armstrong.
 }
 
 \seealso{

diff --git a/man/send.socket.Rd b/man/send.socket.Rd
@@ -1,32 +1,32 @@
 \name{send.socket}
 \alias{send.socket}
 \title{
-send a message.
+  send a message.
 }
 \description{
-Queue the message referenced by the msg argument to be sent to the socket referenced by the socket argument. 
+  Queue the message referenced by the msg argument to be sent to the socket referenced by the socket argument. 
 
-A successful invocation of zmq_send() does not indicate that the message has been transmitted to the network, only that it has been queued on the socket and ØMQ has assumed responsibility for the message.
+  A successful invocation of send.socket does not indicate that the message has been transmitted to the network, only that it has been queued on the socket and ZMQ has assumed responsibility for the message.
 }
 \usage{
 send.socket(socket, data)
 }
 
 \arguments{
   \item{socket}{a zmq socket object}
-  \item{data}{the R data/object to be sent}
+  \item{data}{the R object to be sent}
 }
 \value{
-a LOGICAL indicating success or failure of the operation.
+  a boolean indicating success or failure of the operation.
 }
 \references{
-http://www.zeromq.org
-http://api.zeromq.org
-http://zguide.zeromq.org/page:all
+  http://www.zeromq.org
+  http://api.zeromq.org
+  http://zguide.zeromq.org/page:all
 }
 \author{
-ZMQ was written by Martin Sustrik <sustrik@250bpm.com> and Martin Lucina <mato@kotelna.sk>.
-rzmq was written by Whit Armstrong.
+  ZMQ was written by Martin Sustrik <sustrik@250bpm.com> and Martin Lucina <mato@kotelna.sk>.
+  rzmq was written by Whit Armstrong.
 }
 
 \seealso{
@@ -52,5 +52,4 @@ while(1) {
    send.socket(out.socket,ans)
 }
 }}
-
 \keyword{utilities}