README: explain how the algorithm works

tummychow / git-absorb

git commit --fixup, but automatic

https://crates.io/crates/git-absorb

BSD 3-Clause "New" or "Revised" License

3.38k stars 58 forks source link

README: explain how the algorithm works #41

Closed gasche closed 3 years ago

gasche commented 3 years ago

Fixes #8

waldyrious commented 3 years ago

I think it would be useful to add a link to https://github.com/tummychow/git-scripts/blob/master/git-absorb.md#interlude-patch-theory at the end of this section. For example:

For additional details, see the documentation here.

gasche commented 3 years ago

I'm not sure; this document is way too long and possibly outdated (for example it refers to an old implementation). I prefer to keep the proposed change as-is, will change if there is more feedback in favor.

waldyrious commented 3 years ago

Sure, I can see your point. 👍

tummychow commented 3 years ago

yeah okay this is an acceptable summary. i agree that the old documentation shouldn't be referenced here, that form of commutation just does not work