Skip to content
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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

ShahanaFarooqui
Copy link
Collaborator

A test script to generate/refresh rpc requests and responses in document examples.

Changelog-None.

@ShahanaFarooqui ShahanaFarooqui force-pushed the docs-autogen-examples branch 29 times, most recently from 9e9c4ef to 2920015 Compare July 13, 2024 00:30
@ShahanaFarooqui ShahanaFarooqui force-pushed the docs-autogen-examples branch 9 times, most recently from 221a4a7 to e2b8b6a Compare July 19, 2024 06:54
@ShahanaFarooqui ShahanaFarooqui marked this pull request as ready for review July 19, 2024 19:13
@ShahanaFarooqui ShahanaFarooqui marked this pull request as draft July 19, 2024 19:31
@ShahanaFarooqui ShahanaFarooqui force-pushed the docs-autogen-examples branch 4 times, most recently from f0abf6b to a8d17c0 Compare July 23, 2024 02:02
@ShahanaFarooqui ShahanaFarooqui marked this pull request as ready for review July 23, 2024 02:05
@ShahanaFarooqui ShahanaFarooqui force-pushed the docs-autogen-examples branch 2 times, most recently from d3fec8f to 9f46918 Compare July 25, 2024 01:47
@ShahanaFarooqui ShahanaFarooqui requested review from endothermicdev and removed request for cdecker July 25, 2024 19:31
@ShahanaFarooqui ShahanaFarooqui force-pushed the docs-autogen-examples branch 2 times, most recently from 9fdfaf1 to 06c18b7 Compare July 27, 2024 01:00
- `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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Highlight - UX and Dev Experience Fit and finish to make higher layer devs joyous
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant