Update listsendpays documentation to explain when amount_msat is not present #8144
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…present Fixes ElementsProject#6909 Update the documentation of `listsendpays` to be more explicit about when the `amount_msat` field might not be present. * Update the description of the `amount_msat` field in `doc/schemas/lightning-listsendpays.json` to explain that it might not be present if the payment is still pending or if the amount delivered to the destination is not known. * Add a note in the `response` section to indicate that if the `amount_msat` field is not present, it means the payment is still pending or the amount delivered to the destination is not known. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ElementsProject/lightning/issues/6909?shareId=XXXX-XXXX-XXXX-XXXX).
Can u brief me about that "extra test" |
|
Sorry I made a typo, you need to update the md file too, there is an extra step that is running |
|
Can you specify which md file |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #6909
Update the documentation of
listsendpaysto be more explicit about when theamount_msatfield might not be present.amount_msatfield indoc/schemas/lightning-listsendpays.jsonto explain that it might not be present if the payment is still pending or if the amount delivered to the destination is not known.responsesection to indicate that if theamount_msatfield is not present, it means the payment is still pending or the amount delivered to the destination is not known.For more details, open the Copilot Workspace session.