channelReserve unit unclear from documentationSee original GitHub issue
Expected: API doc clearly states whether
channelReserve is sat or msat.
Current state: API doc has no such informtion. Quick look at the code suggests that it’s most likely in sats. This seems to make sense looking at the data.
Steps to reproduce:
- open https://acinq.github.io/eclair/#channels-2
- look at channel reserve
Version and environment: Irrelevant, I believe
- Created 2 years ago
- Comments:5 (4 by maintainers)
Top GitHub Comments
The website has been updated with the latest documentation. Thanks for your contribution!
You don’t need to work with slate, just modify the markdown in
index.html.md in the
slate-doc branch and open a PR with your changes, and I’ll run the slate scripts to build the HTML site and deploy.
You can just add a sentence explaining that specific fields are in satoshi in the section for that request/response (since JSON doesn’t support inline comments). Or whatever you think is the best way to make it obvious to future readers.