Skip to content

Commit

Permalink
devrpc: remove lncli API docs tag [skip ci]
Browse files Browse the repository at this point in the history
The API doc generator failed after merging lightningnetwork#6149 because of the `lncli
importgraph` tag in the proto file.
We could also fix the API doc generator by adding the "dev" build tag,
but not including any dev only features in the API docs is probably the
preferred path.
  • Loading branch information
guggero committed Jan 31, 2022
1 parent 8d40c89 commit a5849bb
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion lnrpc/devrpc/dev.proto
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ package devrpc;
option go_package = "github.com/lightningnetwork/lnd/lnrpc/devrpc";

service Dev {
/* lncli: `importgraph`
/*
ImportGraph imports a ChannelGraph into the graph database. Should only be
used for development.
*/
Expand Down
2 changes: 1 addition & 1 deletion lnrpc/devrpc/dev.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"paths": {
"/v2/dev/importgraph": {
"post": {
"summary": "lncli: `importgraph`\nImportGraph imports a ChannelGraph into the graph database. Should only be\nused for development.",
"summary": "ImportGraph imports a ChannelGraph into the graph database. Should only be\nused for development.",
"operationId": "Dev_ImportGraph",
"responses": {
"200": {
Expand Down
4 changes: 2 additions & 2 deletions lnrpc/devrpc/dev_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a5849bb

Please sign in to comment.