Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rklaehn committed Nov 18, 2024
1 parent bd6b1de commit fbddd98
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ futures-lite = "2.3.0"
futures-util = { version = "0.3.25" }
hex = "0.4"
iroh-base = "0.28.0"
iroh-blobs = { version = "0.28.0", optional = true, features = ["downloader"] }
iroh-blobs = { version = "0.28.0", optional = true, features = ["downloader", "rpc"] }
iroh-gossip = { version = "0.28.0", optional = true }
iroh-metrics = { version = "0.28.0", default-features = false }
iroh-net = { version = "0.28.0", optional = true }
Expand Down
10 changes: 5 additions & 5 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ impl ConsolePaths {
/// Environment for CLI and REPL
///
/// This is cheaply cloneable and has interior mutability. If not running in the console
/// environment, [Self::set_doc] and [Self::set_author] will lead to an error, as changing the
/// environment, `Self::set_doc` and `Self::set_author` will lead to an error, as changing the
/// environment is only supported within the console.
#[derive(Clone, Debug)]
pub struct ConsoleEnv(Arc<RwLock<ConsoleEnvInner>>);

#[derive(PartialEq, Eq, Debug, Deserialize, Serialize, Clone)]
struct ConsoleEnvInner {
/// Active author. Read from IROH_AUTHOR env variable.
/// For console also read from/persisted to a file (see [`ConsolePaths::DefaultAuthor`])
/// For console also read from/persisted to a file.
/// Defaults to the node's default author if both are empty.
author: AuthorId,
/// Active doc. Read from IROH_DOC env variable. Not persisted.
Expand Down Expand Up @@ -292,11 +292,11 @@ pub enum DlPolicyCmd {
/// Set the general download policy for this document.
kind: FetchKind,
/// Add an exception to the download policy.
/// An exception must be formatted as <matching_kind>:<encoding>:<pattern>.
/// An exception must be formatted as `<matching_kind>:<encoding>:<pattern>`.
///
/// - <matching_kind> can be either `prefix` or `exact`.
///
/// - <encoding> can be either `utf8` or `hex`.
/// - `<encoding>` can be either `utf8` or `hex`.
#[clap(short, long, value_name = "matching_kind>:<encoding>:<pattern")]
except: Vec<FilterKind>,
},
Expand Down Expand Up @@ -903,7 +903,7 @@ impl DocCommands {
}
}

/// Gets the document given the client, the environment (and maybe the [`NamespaceID`]).
/// Gets the document given the client, the environment (and maybe the [`crate::keys::NamespaceId`]).
async fn get_doc(
docs: &docs::Client,
env: &ConsoleEnv,
Expand Down

0 comments on commit fbddd98

Please sign in to comment.