Skip to content

Commit

Permalink
docs(iroh-cli): update tags command documentation (#2709)
Browse files Browse the repository at this point in the history
## 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.
  • Loading branch information
palozano authored Sep 6, 2024
1 parent bdaeba1 commit 7510a59
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions iroh-cli/src/commands/tags.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
//! Define the tags subcommand.

use anyhow::Result;
use bytes::Bytes;
use clap::Subcommand;
use futures_lite::StreamExt;
use iroh::blobs::Tag;
use iroh::client::Iroh;
use iroh::{blobs::Tag, client::Iroh};

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

impl TagCommands {
/// Runs the tag command given the iroh client.
pub async fn run(self, iroh: &Iroh) -> Result<()> {
match self {
Self::List => {
Expand Down

0 comments on commit 7510a59

Please sign in to comment.