Browse files

Fixed a non-critical returnRef bug in redisConnect

  • Loading branch information...
1 parent 5c197a8 commit 5e85527a58ca91497fce4c10c1712a4b27a39309 B. W. Lewis committed Jun 3, 2010
Showing with 5 additions and 4 deletions.
  1. +1 −1 R/controlCMD.R
  2. +4 −3 man/redisConnect.Rd
2 R/controlCMD.R
@@ -21,7 +21,7 @@ function(host='localhost', port=6379, returnRef=FALSE)
if(returnRef) return(list(con=.redisEnv$con, host=.redisEnv$host,
- port=redisEnv$port))
+ port=.redisEnv$port))
7 man/redisConnect.Rd
@@ -8,7 +8,7 @@ redisConnect(host = "localhost", port = 6379, returnRef = FALSE)
\item{host}{The Redis server host name or inet address (optional, character)}
\item{port}{The Redis port number (optional, numeric or integer)}
- \item{returnRef}{Set returnRef=TRUE to return a list describing the Redis connection.}
+ \item{returnRef}{Set returnRef=TRUE to return a list describing the Redis connection (not presently useful).}
\details{A running instance of a Redis server is required. See for details.}
@@ -18,8 +18,9 @@ connect to the specified Redis server. Disconnect from a connected server
with redisClose.
If returnRef is set to TRUE and no error occurs, a list describing the
-Redis connection will be returned. The list can be used to manage multiple
-Redis connections with the \code{attachRedis} function.
+Redis connection will be returned. A future version of the package will
+use this feature to support multiple Redis connections with
+the \code{attachRedis} function.
See for details.

0 comments on commit 5e85527

Please sign in to comment.