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(iroh-cli): add docs to entrypoint #2697

Merged
merged 4 commits into from
Sep 5, 2024

Conversation

palozano
Copy link
Contributor

@palozano palozano commented Sep 5, 2024

Description

Add documentation to undocumented items in the entrypoint for the iroh-cli at iroh/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

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

Co-authored-by: Philipp Krüger <[email protected]>
palozano and others added 2 commits September 5, 2024 12:34
Co-authored-by: Philipp Krüger <[email protected]>
Co-authored-by: Philipp Krüger <[email protected]>
Copy link
Member

@matheus23 matheus23 left a 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! :)

@palozano
Copy link
Contributor Author

palozano commented Sep 5, 2024

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)].

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

Anyhow, still good to have this. Next up some help in the submodules (authors/blobs/start/tags etc.) would be amazing! :)

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!

@matheus23 matheus23 added this pull request to the merge queue Sep 5, 2024
Merged via the queue into n0-computer:main with commit c6e2f05 Sep 5, 2024
28 checks passed
@palozano palozano deleted the palozano/cli-docs branch September 5, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants