-
Notifications
You must be signed in to change notification settings - Fork 890
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
Auto Generate Doc Examples #7457
Merged
ShahanaFarooqui
merged 6 commits into
ElementsProject:master
from
ShahanaFarooqui:docs-autogen-examples
Aug 10, 2024
Merged
Auto Generate Doc Examples #7457
ShahanaFarooqui
merged 6 commits into
ElementsProject:master
from
ShahanaFarooqui:docs-autogen-examples
Aug 10, 2024
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
9e9c4ef
to
2920015
Compare
3ffaa06
to
8fad531
Compare
Ack 8fad531 The commit which actually populates all the examples definitely needs a Changelog-Added line! Remember, if you want something mentioned in the release announcement, ensure it has a Changelog! Something like:
After that, please apply! |
a8b23ca
to
80e7c7d
Compare
- `Notes` is not a required field in renepaystatus response
Bitcoind's web server has a default of 4 threads, with queue depth 16 and it fails rather than queue beyond that. Increasing thread count to 20 for running >10 lightning test nodes simultaneously.
I will commit doc/schemas/lightning-*.json files separately to keep this commit easier to review. - test-autogenerate-rpc-examples updates all example request & responses in doc/schemas/lightning-*.json files. - Updated tools/fromschema.py to accommodate the sql JSON example requirement where it does not accept -o in the query but shell does (for queries containing the = sign). Changelog-None.
Changelog-Added: doc: all examples in the documentation are now generated from running the code, so they are current.
64f5847
to
f5d7d1f
Compare
f5d7d1f
to
1d1e605
Compare
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
A test script to generate/refresh rpc requests and responses in document examples.
Changelog-Added: doc: all examples in the documentation are now generated from running the code, so they are current.