minor: RUBY-257 note log_message is a no-op on Connection#receive_message.

This commit is contained in:
Kyle Banker 2011-05-10 14:35:51 -04:00
parent f7e1feaeba
commit 505bc68aab
1 changed files with 3 additions and 0 deletions

View File

@ -458,7 +458,10 @@ module Mongo
# #
# @param [Integer] operation a MongoDB opcode. # @param [Integer] operation a MongoDB opcode.
# @param [BSON::ByteBuffer] message a message to send to the database. # @param [BSON::ByteBuffer] message a message to send to the database.
# @param [String] log_message this is currently a no-op and will be removed.
# @param [Socket] socket a socket to use in lieu of checking out a new one. # @param [Socket] socket a socket to use in lieu of checking out a new one.
# @param [Boolean] command (false) indicate whether this is a command. If this is a command,
# the message will be sent to the primary node.
# #
# @return [Array] # @return [Array]
# An array whose indexes include [0] documents returned, [1] number of document received, # An array whose indexes include [0] documents returned, [1] number of document received,