Skip to content

Commit

Permalink
docs: emphasize pipelining caveats in its docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vladfaust committed Apr 15, 2019
1 parent 344cb78 commit e75095f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/mini_redis.cr
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,15 @@ class MiniRedis
#
# ```
# response = redis.pipeline do |pipe|
# # WARNING: Do not try to access its return value while
# # within the pipeline block. See the explaination below
# pipe.send("PING")
# end
#
# pp response # => Array([MiniRedis::Value(@raw="PONG")])
# ```
#
# NOTE: `#send` returns an `uninitalized Value` when in pipeline mode.
# WARNING: `#send` returns an `uninitalized Value` when in pipeline mode.
# Trying to access it would crash the program. Use `#pipeline?` if you want to be sure.
#
# ```
Expand Down

0 comments on commit e75095f

Please sign in to comment.