Add deprecation / addition information to schemas #5867
Merged
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
cdecker
reviewed
Jan 3, 2023
doc/lightning-listpeers.7.md
Outdated
| - **local\_msat** (msat, optional): Amount of channel we funded (deprecated) | ||
| - **remote\_msat** (msat, optional): Amount of channel they funded (deprecated) | ||
| - **local\_msat** (msat, optional): Amount of channel we funded **deprecated, removal in v23.5** | ||
| - **remote\_msat** (msat, optional): Amount of channel they funded **deprecated, removal in v23.5** |
There was a problem hiding this comment.
Needs 0-padding on the month, otherwise lexicographic sorting of versions is broken.
rustyrussell
force-pushed
the
guilt/schema-deprecations
branch
from
fc65194
to
c725d22
Compare
Yeah, this is better than nothing, but far from ideal. In practice I wanted to make sure we didn't merge anything which changed the API by accident, and this should suffice for that in practice. |
rustyrussell
force-pushed
the
guilt/schema-deprecations
branch
from
c725d22
to
dffe061
Compare
No longer just delete them! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
…mas. This means we will document deprecations and additions, rather than just pretending they've always been that way! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
…precate. TODO: It would be great to similarly annotate new/deprecated commands and their parameters. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: doc: we now annotate what versions JSON field additions and deprecations happenened.
…te non-deprcated. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell
force-pushed
the
guilt/schema-deprecations
branch
from
dffe061
to
9cc372d
Compare
|
Trivial rebase. Ack 9cc372d |
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.
This opens the door to far better documentation (we used to just not mention now-deprecated fields, and never noted what version a field was added!), but also lets the SQL plugin (#5679) handle deprecations more gracefully (it can ignore anything deprecated before it was released, for example).
Note that #5825 should be rebased onto this (as it currently removes deprecated fields from schema).