-
Notifications
You must be signed in to change notification settings - Fork 888
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for dev-forget-channel
command too
#6923
Comments
@ecurrencyhodler told me about this issue on stakwork. I am interested. @ShahanaFarooqui |
I wonder if we should really be documenting these. We decided against including the These then would also be documented, exposed to users, and users that do not know the intricacies of the @rustyrussell what do you think? |
Adding some context from where it started: A user wanted to forget 3 channels and was unable to execute the command due to missing However, we can show these commands under |
I was just about to ask @ShahanaFarooqui to clarify the task. Either way I am totally ok what your decision is, to document or not to document. I just got my environment updated and probably won't have time to work on it immediately, so no worries if you guys want to cancel this task. We can also just make a framework and leave it with placeholders if you want. |
dev
commands toodev-forget-channel
command too
@cdecker After confirming with @rustyrussell, we decided to only add documentation for |
@ShahanaFarooqui ok I'll take a look this weekend and will send questions here if not clear. thanks for the update |
Currently, documentation for
dev-forget-channel
command is missing and will be helpful to add for easier user reference.For the RPC command:
*.request.json
indoc/schemas
with RPC request inputs types, descriptions, etc.*.schema.json
indoc/schemas
, detailing RPC response, fields descriptions, defaults, etc.lightning-*.7.md
file indoc
, whereRETURN VALUE
should be generated dynamically usingtools/fromschema.py
scriptmake doc-all
should auto generatelightning-*.7
fromlightning-*.7.md
The text was updated successfully, but these errors were encountered: