SwiftLightning icon indicating copy to clipboard operation
SwiftLightning copied to clipboard

documentation: Describe the state machine

Open jkczyz opened this issue 4 years ago • 2 comments

The state machine is mentioned but isn't well defined. Give a brief description where it is introduced.

jkczyz avatar Jun 17 '20 07:06 jkczyz

Where do you think this description is most aptly placed?

arik-so avatar Jun 17 '20 18:06 arik-so

Probably in README.md under "Channel Management" where the term is first used. Just needs a little clarification because, as stated, "the state machine" leaves a lot to the imagination. What's state? What causes state transitions?

It may sufficient to rephrase the entire sentence if the remaining responsibilities in the list are related to the state machine management. That is, define the state machine in terms of these instead.

jkczyz avatar Jun 17 '20 19:06 jkczyz