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

Merged

Conversation

ShahanaFarooqui
Copy link
Collaborator

@ShahanaFarooqui ShahanaFarooqui commented Jul 8, 2024

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.

@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 4 times, most recently from 3ffaa06 to 8fad531 Compare August 2, 2024 18:06
@rustyrussell
Copy link
Contributor

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:

Changelog-Added: doc: all examples in the documentation are now generated from running the code, so they are current.

After that, please apply!

@ShahanaFarooqui ShahanaFarooqui force-pushed the docs-autogen-examples branch 6 times, most recently from a8b23ca to 80e7c7d Compare August 8, 2024 23:54
- `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.
@ShahanaFarooqui ShahanaFarooqui force-pushed the docs-autogen-examples branch 6 times, most recently from 64f5847 to f5d7d1f Compare August 9, 2024 05:30
@ShahanaFarooqui ShahanaFarooqui modified the milestones: v24.08, v24.11 Aug 9, 2024
@ShahanaFarooqui ShahanaFarooqui merged commit 47e7127 into ElementsProject:master Aug 10, 2024
37 checks passed
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.

2 participants