-
Notifications
You must be signed in to change notification settings - Fork 213
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(iroh-cli): add docs to entrypoint #2697
Conversation
Co-authored-by: Philipp Krüger <[email protected]>
Co-authored-by: Philipp Krüger <[email protected]>
Co-authored-by: Philipp Krüger <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this :)
I think this is great & we can merge as-is, but one thing I wonder is whether the "Manage the RPC" comment makes it into the CLI. Have you checked that by running cargo run -- --help
? I think the comment may end up "unused" due to the #[clap(flatten)]
.
Anyhow, still good to have this. Next up some help in the submodules (authors
/blobs
/start
/tags
etc.) would be amazing! :)
No, it doesn't show up in the CLI, directly picks up the subcommands. I guess that's why it wasn't documented. It'd be nice if it could have the "Manage the RPC: " in front of every subcommand, but I cannot find it
Yes, I have done the other submodules too! I wanted some feedback in case I missed something, so I fix it before opening the other PRs. Thanks! |
Description
Add documentation to undocumented items in the entrypoint for the
iroh-cli
atiroh/iroh-cli/src/commands.rs
.This partially addresses #2660, and belongs to a series of PRs to complete it.
Breaking Changes
No breaking changes.
Notes & open questions
No additional notes.
Change checklist