Skip to content

Commit 60783b7

Browse files
committed
docs: fix rustdoc warnings (broken intra-doc links, bare URLs)
stackable-operator: intra-doc links within the crate must use `crate::` rather than the package name `stackable_operator::`, which is not in scope and produced `broken_intra_doc_links` warnings. Also wrap two bare URLs in the scaler docs in angle brackets so rustdoc renders them as hyperlinks. stackable-telemetry: `SettingsBuilder` is not imported in `tracing/mod.rs` (only `Settings` is), so the four doc links to it did not resolve. Point them at `settings::SettingsBuilder` via the child module, keeping the rendered link text unchanged. `cargo doc --document-private-items` is now warning-free across the workspace.
1 parent a3d29c5 commit 60783b7

7 files changed

Lines changed: 13 additions & 13 deletions

File tree

crates/stackable-operator/src/crd/scaler/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ pub mod versioned {
3131
///
3232
/// Upstream issues:
3333
///
34-
/// - https://github.com/kubernetes/kubernetes/issues/105533
35-
/// - https://github.com/Arnavion/k8s-openapi/issues/136
34+
/// - <https://github.com/kubernetes/kubernetes/issues/105533>
35+
/// - <https://github.com/Arnavion/k8s-openapi/issues/136>
3636
pub replicas: u16,
3737
}
3838
}

crates/stackable-operator/src/v2/builder/meta.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use crate::{
66
};
77

88
/// Infallible variant of
9-
/// [`stackable_operator::builder::meta::ObjectMetaBuilder::ownerreference_from_resource`]
9+
/// [`crate::builder::meta::ObjectMetaBuilder::ownerreference_from_resource`]
1010
pub fn ownerreference_from_resource(
1111
resource: &(impl Resource<DynamicType = ()> + HasName + HasUid),
1212
block_owner_deletion: Option<bool>,

crates/stackable-operator/src/v2/builder/pdb.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use crate::{
99
};
1010

1111
/// Infallible variant of
12-
/// [`stackable_operator::builder::pdb::PodDisruptionBudgetBuilder::new_with_role`]
12+
/// [`crate::builder::pdb::PodDisruptionBudgetBuilder::new_with_role`]
1313
pub fn pod_disruption_budget_builder_with_role(
1414
owner: &(impl Resource<DynamicType = ()> + HasName + NameIsValidLabelValue + HasUid),
1515
product_name: &ProductName,

crates/stackable-operator/src/v2/builder/pod/container.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pub enum Error {
2323
ParseEnvVarName { env_var_name: String },
2424
}
2525

26-
/// Infallible variant of [`stackable_operator::builder::pod::container::ContainerBuilder::new`]
26+
/// Infallible variant of [`crate::builder::pod::container::ContainerBuilder::new`]
2727
pub fn new_container_builder(container_name: &ContainerName) -> ContainerBuilder {
2828
ContainerBuilder::new(container_name.as_ref()).expect("should be a valid container name")
2929
}

crates/stackable-operator/src/v2/builder/pod/volume.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use crate::{
55
v2::types::kubernetes::{ListenerClassName, ListenerName, PersistentVolumeClaimName},
66
};
77

8-
/// Infallible variant of [`stackable_operator::builder::pod::volume::ListenerReference`]
8+
/// Infallible variant of [`crate::builder::pod::volume::ListenerReference`]
99
#[derive(Clone, Debug, Eq, PartialEq)]
1010
pub enum ListenerReference {
1111
ListenerClass(ListenerClassName),
@@ -26,7 +26,7 @@ impl From<&ListenerReference> for crate::builder::pod::volume::ListenerReference
2626
}
2727

2828
/// Infallible variant of
29-
/// [`stackable_operator::builder::pod::volume::ListenerOperatorVolumeSourceBuilder::build_pvc`]
29+
/// [`crate::builder::pod::volume::ListenerOperatorVolumeSourceBuilder::build_pvc`]
3030
pub fn listener_operator_volume_source_builder_build_pvc(
3131
listener_reference: &ListenerReference,
3232
labels: &Labels,

crates/stackable-operator/src/v2/role_utils.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ use crate::{
2222
schemars::{self, JsonSchema},
2323
};
2424

25-
// Variant of [`stackable_operator::role_utils::GenericCommonConfig`] that implements [`Merge`]
25+
// Variant of [`crate::role_utils::GenericCommonConfig`] that implements [`Merge`]
2626
#[derive(Clone, Debug, Default, Deserialize, JsonSchema, Eq, PartialEq, Serialize)]
2727
pub struct GenericCommonConfig {}
2828

2929
impl Merge for GenericCommonConfig {
3030
fn merge(&mut self, _defaults: &Self) {}
3131
}
3232

33-
/// Variant of [`stackable_operator::role_utils::RoleGroup`] that is easier to work with
33+
/// Variant of [`crate::role_utils::RoleGroup`] that is easier to work with
3434
///
3535
/// Differences are:
3636
/// * `replicas` is non-optional.

crates/stackable-telemetry/src/tracing/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ pub enum Error {
133133
/// ## Builders
134134
///
135135
/// When choosing the builder, there are two different styles to configure individual subscribers:
136-
/// Using the sophisticated [`SettingsBuilder`] or the simplified tuple style for basic
136+
/// Using the sophisticated [`SettingsBuilder`](settings::SettingsBuilder) or the simplified tuple style for basic
137137
/// configuration. Currently, three different subscribers are supported: console output, OTLP log
138138
/// export, and OTLP trace export.
139139
///
@@ -173,9 +173,9 @@ pub enum Error {
173173
/// subscriber provides specific settings based on a common set of options. These options can be
174174
/// customized via the following methods:
175175
///
176-
/// - [`SettingsBuilder::console_log_settings_builder`]
177-
/// - [`SettingsBuilder::otlp_log_settings_builder`]
178-
/// - [`SettingsBuilder::otlp_trace_settings_builder`]
176+
/// - [`SettingsBuilder::console_log_settings_builder`](settings::SettingsBuilder::console_log_settings_builder)
177+
/// - [`SettingsBuilder::otlp_log_settings_builder`](settings::SettingsBuilder::otlp_log_settings_builder)
178+
/// - [`SettingsBuilder::otlp_trace_settings_builder`](settings::SettingsBuilder::otlp_trace_settings_builder)
179179
///
180180
/// ```
181181
/// # use stackable_telemetry::tracing::{Tracing, Error, settings::Settings};

0 commit comments

Comments
 (0)