vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(swarm-queue-client): qualify the status-bucket intra-doc link

Browse source 
An unqualified `[`open_or_create`]` in the module-level doc does not
resolve once the `kv` feature is on, which is the only configuration
where the module is compiled at all — so `docs-rustdoc` failed in CI
while a default-feature `cargo doc` passed locally. Measured both ways:
kv off documents clean, kv on errors `no item named open_or_create in
scope`.

Qualifying the path fixes it without widening any visibility, which is
the rule that check exists to protect.
This commit is contained in:
atlas 2026-08-16 13:52:43 +02:00
commit b8e19a31b2
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
swarm-queue-client/src/status.rs
View file

@ -7,7 +7,7 @@
//! repeated across crates is an agreement nothing checks.** //! repeated across crates is an agreement nothing checks.**
//! //!
//! The name is the obvious half. The sharper half is the *config*: both //! The name is the obvious half. The sharper half is the *config*: both
//! ends open the bucket with [`open_or_create`], because either may //! ends open the bucket with [`crate::status::open_or_create`], because either may
//! arrive first on a fresh swarm and neither can assume the other has //! arrive first on a fresh swarm and neither can assume the other has
//! run. If the two ends passed different `Config`s, whichever created it //! run. If the two ends passed different `Config`s, whichever created it
//! would win and the other's `get_key_value` would succeed against a //! would win and the other's `get_key_value` would succeed against a