diff --git a/src/khepri_adv.erl b/src/khepri_adv.erl index d98d9080..969071df 100644 --- a/src/khepri_adv.erl +++ b/src/khepri_adv.erl @@ -332,11 +332,18 @@ put(StoreId, PathPattern, Data) -> %% in the path pattern is not met, an error is returned and the tree structure %% is not modified. %% -%% The returned `{ok, NodeProps}' tuple contains a map with the properties and -%% payload (if any) of the targeted tree node: the payload was the one before -%% the update, other properties like the payload version correspond to the -%% updated node. If the targeted tree node didn't exist, `NodeProps' will be -%% an empty map. +%% The returned `{ok, NodePropsMap}' tuple contains a map where keys correspond +%% to the path to a node affected by the put operation. Each key points to a +%% map containing the properties and prior payload (if any) of a tree node +%% created, updated or deleted by the put operation. If the put results in the +%% creation of a tree node this props map will be empty. If the put updates an +%% existing tree node then the props map will contain the payload of the tree +%% node (if any) before the update while the other properties like the payload +%% version correspond to the updated node. The `NodePropsMap' map might also +%% contain deletions if the put operation leads to an existing tree node's +%% keep-while condition becoming unsatisfied. The props map for any nodes +%% deleted because of an expired keep-while condition will contain a +%% `delete_reason' key set to `keep_while'. %% %% The payload must be one of the following form: %%