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

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

Conversation

evansmj
Copy link
Contributor

@evansmj evansmj commented Aug 25, 2024

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.
  • 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.
  • 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
Copy link
Contributor

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

@evansmj evansmj force-pushed the evansmj/autogenerate-schemas-docs-clarity-and-spellings branch 2 times, most recently from 4d6c917 to 6634c53 Compare August 26, 2024 23:28
@evansmj
Copy link
Contributor Author

evansmj commented Aug 26, 2024

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

fixed

@niftynei
Copy link
Contributor

ACK 6634c53

Spelling and clarity on how to update schemas when adding RPCs.
@ShahanaFarooqui ShahanaFarooqui force-pushed the evansmj/autogenerate-schemas-docs-clarity-and-spellings branch from 6634c53 to 40e54b3 Compare September 5, 2024 19:45
@ShahanaFarooqui ShahanaFarooqui merged commit 873e8b4 into ElementsProject:master Sep 6, 2024
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants