Workspace refactoring broke documentation links
TilBlechschmidt opened this issue · comments
Refactoring the core project into a workspace broke countless documentation links 😢
Documenting library v0.1.0 (/home/rust/src/library)
warning: unresolved link to `super::domain`
--> library/src/lib.rs:7:35
|
7 | //! extracted into the [`domain`](super::domain) module.
| ^^^^^^^^^^^^^ no item named `super` in scope
|
= note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
warning: unresolved link to `ConsumerIdentifier`
--> library/src/communication/event/queue_provider.rs:13:5
|
13 | / /// Subscribes to new notifications on a given queue joining the specified [`ConsumerGroup`](ConsumerGroupDescriptor)
14 | | /// with the given [`ConsumerIdentifier`] or creates it if it does not exist.
| |_________________________________________________________________________________^
|
= note: the link appears in this line:
with the given [`ConsumerIdentifier`] or creates it if it does not exist.
^^^^^^^^^^^^^^^^^^^^
= note: no item named `ConsumerIdentifier` in scope
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `self::library::communication::event::QueueEntry`
--> library/src/communication/implementation/redis/queue_entry.rs:12:54
|
12 | /// Redis based implementation of the [`QueueEntry`](crate::library::communication::event::QueueEntry) trait
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `library` in module `library`
Checking domain v0.1.0 (/home/rust/src/domain)
Documenting domain v0.1.0 (/home/rust/src/domain)
warning: `library` (lib doc) generated 3 warnings
Checking harness v0.1.0 (/home/rust/src/harness)
Documenting harness v0.1.0 (/home/rust/src/harness)
warning: unresolved link to `self::module::api`
--> domain/src/discovery.rs:8:17
|
8 | /// [`Api`](crate::module::api) instance
| ^^^^^^^^^^^^^^^^^^ no item named `module` in module `domain`
|
= note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
warning: unresolved link to `self::module::node`
--> domain/src/discovery.rs:10:18
|
10 | /// [`Node`](crate::module::node) instance
| ^^^^^^^^^^^^^^^^^^^ no item named `module` in module `domain`
warning: unresolved link to `super::super::library::communication::event::Notification`
--> domain/src/event/mod.rs:1:38
|
1 | //! Domain specific [`Notification`](super::super::library::communication::event::Notification) structures
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `super` in module `domain`
warning: unresolved link to `self::library::communication::event::QueueDescriptorExtension`
--> domain/src/event/provisioner.rs:23:67
|
23 | /// It is intended to be used with a [`QueueDescriptorExtension`](crate::library::communication::event::QueueDescriptorExtension)
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `library` in module `domain`
warning: unresolved link to `self::domain::webdriver::CapabilitiesRequest`
--> domain/src/event/provisioner.rs:30:37
|
30 | /// Raw [`CapabilitiesRequest`](crate::domain::webdriver::CapabilitiesRequest) json string used for scheduling.
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `domain` in module `domain`
warning: unresolved link to `self::domain::webdriver::CapabilitiesRequest`
--> domain/src/event/session/created.rs:19:37
|
19 | /// Raw [`CapabilitiesRequest`](crate::domain::webdriver::CapabilitiesRequest) json string provided by the end-user
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `domain` in module `domain`
warning: unresolved link to `self::library::communication::discovery`
--> domain/src/event/session/operational.rs:12:20
|
12 | /// [discoverable](crate::library::communication::discovery), and can
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `library` in module `domain`
warning: unresolved link to `self::domain::webdriver::Capabilities`
--> domain/src/event/session/operational.rs:19:30
|
19 | /// Raw [`Capabilities`](crate::domain::webdriver::Capabilities) json string
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `domain` in module `domain`
warning: unresolved link to `Heart`
--> domain/src/event/session/terminated.rs:36:11
|
36 | /// [`Heart`] provided by module died
| ^^^^^ no item named `Heart` in scope
|
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `super::super::library::communication::request::Request`
--> domain/src/request/mod.rs:1:33
|
1 | //! Domain specific [`Request`](super::super::library::communication::request::Request) structures
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `super` in module `domain`
warning: unresolved link to `self::domain::webdriver::CapabilitiesRequest`
--> domain/src/webdriver/capabilities.rs:238:33
|
238 | /// Raw [`CapabilitiesRequest`](crate::domain::webdriver::CapabilitiesRequest) json string containing all fields
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `domain` in module `domain`
warning: unresolved link to `self::module::api`
--> domain/src/discovery.rs:8:17
|
8 | /// [`Api`](crate::module::api) instance
| ^^^^^^^^^^^^^^^^^^ no item named `module` in module `domain`
Checking modules v0.1.0 (/home/rust/src/modules)
Documenting modules v0.1.0 (/home/rust/src/modules)
warning: public documentation for `RedisCommunicationFactory` links to private item `MonitoredRedisFactory`
--> harness/src/redis/factory.rs:95:38
|
95 | /// Communication factory based on [`MonitoredRedisFactory`]
| ^^^^^^^^^^^^^^^^^^^^^ this item is private
|
= note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
= note: this link will resolve properly if you pass `--document-private-items`
warning: unresolved link to `self::library::communication::request::Responder`
--> harness/src/service.rs:23:60
|
23 | /// function would return an instance of [`Responder`](crate::library::communication::request::Responder)
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `library` in module `harness`
|
= note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
warning: public documentation for `RedisCommunicationFactory` links to private item `MonitoredRedisFactory`
--> harness/src/redis/factory.rs:95:38
|
95 | /// Communication factory based on [`MonitoredRedisFactory`]
| ^^^^^^^^^^^^^^^^^^^^^ this item is private
|
= note: this link will resolve properly if you pass `--document-private-items`
warning: unresolved link to `self::library::communication::request::Responder`
--> harness/src/service.rs:23:60
|
23 | /// function would return an instance of [`Responder`](crate::library::communication::request::Responder)
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `library` in module `harness`
warning: `domain` (lib doc) generated 12 warnings
warning: `harness` (lib doc) generated 4 warnings
warning: unresolved link to `self::domain::request::ProvisionerMatchRequest`
--> modules/src/orchestrator/services/matching/mod.rs:1:67
|
1 | //! Structures related to processing [`ProvisionerMatchRequests`](crate::domain::request::ProvisionerMatchRequest)
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `domain` in module `modules`
|
= note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
warning: `modules` (lib doc) generated 1 warning
Documenting webgrid v0.1.0 (/home/rust/src/webgrid)
Finished release [optimized] target(s) in 25.26s