Skip to content

Commit 7510a59

Browse files
authored
docs(iroh-cli): update tags command documentation (#2709)
## Description <!-- A summary of what this pull request achieves and a rough list of changes. --> Update documentation to `tags` command. This partially addresses #2660, and belongs to a series of PRs to complete it ## Breaking Changes <!-- Optional, if there are any breaking changes document them, including how to migrate older code. --> ## Notes & open questions Imports have been formated to be grouped. ## Change checklist - [ ] Self-review. - [X] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [ ] Tests if relevant. - [ ] All breaking changes documented.
1 parent bdaeba1 commit 7510a59

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

iroh-cli/src/commands/tags.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1+
//! Define the tags subcommand.
2+
13
use anyhow::Result;
24
use bytes::Bytes;
35
use clap::Subcommand;
46
use futures_lite::StreamExt;
5-
use iroh::blobs::Tag;
6-
use iroh::client::Iroh;
7+
use iroh::{blobs::Tag, client::Iroh};
78

9+
/// Commands to manage tags.
810
#[derive(Subcommand, Debug, Clone)]
911
#[allow(clippy::large_enum_variant)]
1012
pub enum TagCommands {
@@ -19,6 +21,7 @@ pub enum TagCommands {
1921
}
2022

2123
impl TagCommands {
24+
/// Runs the tag command given the iroh client.
2225
pub async fn run(self, iroh: &Iroh) -> Result<()> {
2326
match self {
2427
Self::List => {

0 commit comments

Comments
 (0)