search

Nebo15 / sage

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

Readme not in sync with code #39

Closed barttenbrinke closed 4 years ago

barttenbrinke commented 5 years ago

Hi - first off let me say that sage is super cool! I've been using it in my project for a few weeks now and it REALLY clears things up.

One small thing that had me puzzled was that the readme examples all talk about fallbacks having /3 arguments: 

 |> run(:plans, &fetch_subscription_plans/2, &subscription_plans_circuit_breaker/3)
 |> run(:subscription, &create_subscription/2, &delete_subscription/3)

which gives you a compile error, as the code currently requires /4 :

effect_to_compensate, effects_so_far, name_and_reason, attrs

Would it be okay if I wrote a PR for this?

Thanks again! Bart

AndrewDryga commented 5 years ago

@barttenbrinke Hi, thank you for using Sage. And sure, feel free to send PR :).