swarm-queue-client: fix broken intra-doc link in agent_status key()
This commit is contained in:
parent
e6d5e2da28
commit
4383760807
1 changed files with 7 additions and 1 deletions
|
|
@ -36,8 +36,14 @@ pub const BUCKET: &str = "agent-status";
|
||||||
///
|
///
|
||||||
/// `/`-joined rather than NATS's usual `.`-joined subject style: this is a
|
/// `/`-joined rather than NATS's usual `.`-joined subject style: this is a
|
||||||
/// KV key, not a subject, and neither `hive` nor `agent` names can contain
|
/// KV key, not a subject, and neither `hive` nor `agent` names can contain
|
||||||
/// `/` ([`hive_types::Ident`]'s charset is `[a-z0-9-]`), so the join is
|
/// `/` (`hive_types::Ident`'s charset is `[a-z0-9-]`), so the join is
|
||||||
/// unambiguous to split back apart if a consumer ever needs to.
|
/// unambiguous to split back apart if a consumer ever needs to.
|
||||||
|
///
|
||||||
|
/// Plain code span above, deliberately not an intra-doc link — this crate
|
||||||
|
/// doesn't depend on `hive_types`, and a bracketed reference to its `Ident`
|
||||||
|
/// type fails `cargo doc` with "no item named `hive_types` in scope" under
|
||||||
|
/// this workspace's `docs-rustdoc` CI job, which treats broken doc links as
|
||||||
|
/// errors.
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn key(hive: &str, agent: &str) -> String {
|
pub fn key(hive: &str, agent: &str) -> String {
|
||||||
format!("{hive}/{agent}")
|
format!("{hive}/{agent}")
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue