# Inch CI

Redis#blpop

Parsed documentation:

Remove and get the first element in a list, or block until one is available.

@example With timeout
  list, element = redis.blpop("list", :timeout => 5)
    # => nil on timeout
    # => ["list", "element"] on success
@example Without timeout
  list, element = redis.blpop("list")
    # => ["list", "element"]
@example Blocking pop on multiple lists
  list, element = redis.blpop(["list", "another_list"])
    # => ["list", "element"]

@param [String, Array<String>] keys one or more keys to perform the
  blocking pop on
@param [Hash] options
  - `:timeout => Fixnum`: timeout in seconds, defaults to no timeout

@return [nil, [String, String]]
  - `nil` when the operation timed out
  - tuple of the list that was popped from and element was popped otherwise

Suggestions:

Describe the parameter "args".

Please help! Open an issue on GitHub if this assessment is incorrect.

Inch CI evaluates your project's inline code documentation and reports grades for each class, module and method.

It is an open source project, created by René Föhring (@rrrene), based on Inch.

Please create an issue if anything seems broken or worthy of improvement.