Nebo15 / sage

A dependency-free tool to run distributed transactions in Elixir, inspired by Sagas pattern.
MIT License
912 stars 40 forks source link

Wrong transaction return type description in the docs #79

Open a3kov opened 1 year ago

a3kov commented 1 year ago

From the docs https://hexdocs.pm/sage/readme.html:

# Transaction behaviour:
# @callback transaction(attrs :: map()) :: {:ok, last_effect :: any(), all_effects :: map()} | {:error, reason :: any()}

But when you actually check the code, the success type is 2-tuple, not 3-tuple