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

taprpc: add missing cli autogen docs #703

Merged
merged 2 commits into from
Nov 28, 2023
Merged

taprpc: add missing cli autogen docs #703

merged 2 commits into from
Nov 28, 2023

Conversation

jharveyb
Copy link
Contributor

Adds some missing tags in the proto files that prevented parts of our API docs page from showing CLI commands when one exists.

Right now this page, https://lightning.engineering/api-docs/api/taproot-assets/taproot-assets/fetch-asset-meta , shows no Shell example even though the command exists.

Also fixes some help comments.

I don't think we can easily add a lint for these comments since some RPC endpoints intentionally don't have a matching CLI cmd, like the PSBT endpoints.

@jharveyb jharveyb changed the title taprpc: add cli autogen docs taprpc: add missing cli autogen docs Nov 28, 2023
Copy link
Member

@guggero guggero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, LGTM 🎉

Copy link
Contributor

@ffranr ffranr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about universe federation config info vs just universe federation config. I can see that we do use info in one other place though.

@ffranr ffranr added this pull request to the merge queue Nov 28, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 28, 2023
@ffranr ffranr added this pull request to the merge queue Nov 28, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 28, 2023
@guggero guggero added this pull request to the merge queue Nov 28, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 28, 2023
@guggero guggero added this pull request to the merge queue Nov 28, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 28, 2023
@guggero
Copy link
Member

guggero commented Nov 28, 2023

We should really fix that race unit test flake... @Roasbeef can you override merge (without queue) please?

@ffranr ffranr added this pull request to the merge queue Nov 28, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 28, 2023
@Roasbeef Roasbeef merged commit 5318848 into main Nov 28, 2023
14 checks passed
@guggero guggero deleted the add_cli_autogen_docs branch November 28, 2023 19:10
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.

4 participants