Merge pull request #104 from mzaccari/socket-doc-fixes

Minor documentation fixes for ZMQ::Util.errno
chuckremes · Dec 6, 2013 · 8758774 · 8758774
2 parents 9de178d + 81ec697
commit 8758774
Showing 1 changed file with 10 additions and 10 deletions.
diff --git a/lib/ffi-rzmq/socket.rb b/lib/ffi-rzmq/socket.rb
@@ -117,7 +117,7 @@ def initialize context_ptr, type, opts = {:receiver_class => ZMQ::Message}
     # Returns 0 when the operation completed successfully.
     # Returns -1 when this operation failed.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     #  rc = socket.setsockopt(ZMQ::LINGER, 1_000)
@@ -192,7 +192,7 @@ def connect address
     # depending upon the value of the socket option ZMQ::LINGER.
     #
     # Returns 0 upon success *or* when the socket has already been closed.
-    # Returns -1 when the operation fails. Check ZMQ.errno for the error code.
+    # Returns -1 when the operation fails. Check ZMQ::Util.errno for the error code.
     #
     #  rc = socket.close
     #  puts("Given socket was invalid!") unless 0 == rc
@@ -222,7 +222,7 @@ def close
     # 1. The message could not be enqueued
     # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def sendmsg message, flags = 0
@@ -239,7 +239,7 @@ def sendmsg message, flags = 0
     # 1. The message could not be enqueued
     # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def send_string string, flags = 0
@@ -258,7 +258,7 @@ def send_string string, flags = 0
     # 1. A message could not be enqueued
     # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def send_strings parts, flags = 0
@@ -276,7 +276,7 @@ def send_strings parts, flags = 0
     # 1. A message could not be enqueued
     # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def sendmsgs parts, flags = 0
@@ -291,7 +291,7 @@ def sendmsgs parts, flags = 0
     # 1. The message could not be enqueued
     # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def send_and_close message, flags = 0
@@ -311,7 +311,7 @@ def send_and_close message, flags = 0
     # 1. The message could not be dequeued
     # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     # The application code is responsible for handling the +message+ object lifecycle
@@ -332,7 +332,7 @@ def recvmsg message, flags = 0
     # 1. The message could not be dequeued
     # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     # The application code is responsible for handling the +message+ object lifecycle
@@ -453,7 +453,7 @@ def recv_multipart list, routing_envelope, flag = 0
     # Returns 0 when the operation completed successfully.
     # Returns -1 when this operation failed.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     #  # retrieve high water mark