Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge pull request #80 from anha0825/master

Edoc fix: get(...) can return unchanged, not {error, unchanged}.
  • Loading branch information...
commit 62124dddb045e5d566a72cdb3cd61b03cea6457e 2 parents a568e40 + c2081a0
@seancribbs seancribbs authored
Showing with 3 additions and 3 deletions.
  1. +3 −3 src/riakc_pb_socket.erl
View
6 src/riakc_pb_socket.erl
@@ -208,18 +208,18 @@ get(Pid, Bucket, Key) ->
%% Will return {error, notfound} if the key is not on the server.
%% @equiv get(Pid, Bucket, Key, Options, Timeout)
-spec get(pid(), bucket(), key(), TimeoutOrOptions::timeout() | get_options()) ->
- {ok, riakc_obj()} | {error, term() | unchanged}.
+ {ok, riakc_obj()} | {error, term()} | unchanged.
get(Pid, Bucket, Key, Timeout) when is_integer(Timeout); Timeout =:= infinity ->
get(Pid, Bucket, Key, [], Timeout);
get(Pid, Bucket, Key, Options) ->
get(Pid, Bucket, Key, Options, default_timeout(get_timeout)).
%% @doc Get bucket/key from the server supplying options and timeout.
-%% <code>{error, unchanged}</code> will be returned when the
+%% <code>unchanged</code> will be returned when the
%% <code>{if_modified, Vclock}</code> option is specified and the
%% object is unchanged.
-spec get(pid(), bucket(), key(), get_options(), timeout()) ->
- {ok, riakc_obj()} | {error, term() | unchanged}.
+ {ok, riakc_obj()} | {error, term()} | unchanged.
get(Pid, Bucket, Key, Options, Timeout) ->
Req = get_options(Options, #rpbgetreq{bucket = Bucket, key = Key}),
gen_server:call(Pid, {req, Req, Timeout}, infinity).
Please sign in to comment.
Something went wrong with that request. Please try again.