evansmj commented 2 months ago

Docs: clarify writing-json-schemas.md and autogenerate-rpc-examples.py

Description

Spelling and clarity on how to update schemas when you have added an RPCs. It wasn't super clear you have to run make again to get schema.json to update. This will help newcomers in the process of adding new RPCs, and make it easier to ctrl-f to find things with the correct spelling.

Changes Made

[ ] Feature: Brief description of the new feature or functionality added.
[ ] Bug Fix: Brief description of the bug fixed and how it was resolved.
[ ] Refactor: Any code improvements or refactoring done without changing the functionality.
[x] Docs only: Contains only documentation improvements.

Checklist

Ensure the following tasks are completed before submitting the PR:

[na] Changelog has been added in relevant commit/s.
[na] Tests have been added or updated to cover the changes.
[x] Documentation has been updated as needed.
[na] Any relevant comments or TODOs have been addressed or removed.

Additional Notes

Found these while helping to add the bkpr-editdescription RPCs. Used the Grazie Clion plugin to find additional typos and grammar fixes.

niftynei commented 2 months ago

LGTM; please remove the "Merge" commit, 78ac895

evansmj commented 2 months ago

LGTM; please remove the "Merge" commit, 78ac895

fixed

niftynei commented 2 months ago

ACK 6634c53abf1ee9fed1e552995d0eaf837849a626

ElementsProject / lightning