Skip to content

Commit e630b2d

Browse files
Fix RustDoc warnings
1 parent 8b71df5 commit e630b2d

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

rust/operator-binary/src/controller/build/node_config.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ impl NodeConfig {
167167
///
168168
/// "zen" is the default if `{DISCOVERY_TYPE}` is not set.
169169
/// It is nevertheless explicitly set here.
170-
/// see https://github.com/opensearch-project/OpenSearch/blob/3.0.0/server/src/main/java/org/opensearch/discovery/DiscoveryModule.java#L88-L89
170+
/// see <https://github.com/opensearch-project/OpenSearch/blob/3.0.0/server/src/main/java/org/opensearch/discovery/DiscoveryModule.java#L88-L89>
171171
///
172172
/// "single-node" disables the bootstrap checks, like validating the JVM and discovery
173173
/// configurations.
@@ -181,22 +181,22 @@ impl NodeConfig {
181181

182182
/// Configuration for `cluster.initial_cluster_manager_nodes` which replaces
183183
/// `cluster.initial_master_nodes`, see
184-
/// https://github.com/opensearch-project/OpenSearch/blob/3.0.0/server/src/main/java/org/opensearch/cluster/coordination/ClusterBootstrapService.java#L79-L93.
184+
/// <https://github.com/opensearch-project/OpenSearch/blob/3.0.0/server/src/main/java/org/opensearch/cluster/coordination/ClusterBootstrapService.java#L79-L93>.
185185
///
186186
/// According to
187-
/// https://docs.opensearch.org/docs/3.0/install-and-configure/configuring-opensearch/discovery-gateway-settings/,
187+
/// <https://docs.opensearch.org/docs/3.0/install-and-configure/configuring-opensearch/discovery-gateway-settings/>,
188188
/// it contains "a list of cluster-manager-eligible nodes used to bootstrap the cluster."
189189
///
190190
/// However, the documentation for Elasticsearch is more detailed and contains the following
191-
/// notes (see https://www.elastic.co/guide/en/elasticsearch/reference/9.0/modules-discovery-settings.html):
191+
/// notes (see <https://www.elastic.co/guide/en/elasticsearch/reference/9.0/modules-discovery-settings.html>):
192192
/// * Remove this setting once the cluster has formed, and never set it again for this cluster.
193193
/// * Do not configure this setting on master-ineligible nodes.
194194
/// * Do not configure this setting on nodes joining an existing cluster.
195195
/// * Do not configure this setting on nodes which are restarting.
196196
/// * Do not configure this setting when performing a full-cluster restart.
197197
///
198198
/// The OpenSearch Helm chart only sets master nodes but does not handle the other cases (see
199-
/// https://github.com/opensearch-project/helm-charts/blob/opensearch-3.0.0/charts/opensearch/templates/statefulset.yaml#L414-L415),
199+
/// <https://github.com/opensearch-project/helm-charts/blob/opensearch-3.0.0/charts/opensearch/templates/statefulset.yaml#L414-L415>),
200200
/// so they are also ignored here for the moment.
201201
fn initial_cluster_manager_nodes(&self) -> String {
202202
if !self.cluster.is_single_node()
@@ -231,7 +231,7 @@ impl NodeConfig {
231231
pod_names.join(",")
232232
} else {
233233
// This setting is not allowed on single node cluster, see
234-
// https://github.com/opensearch-project/OpenSearch/blob/3.0.0/server/src/main/java/org/opensearch/cluster/coordination/ClusterBootstrapService.java#L126-L136
234+
// <https://github.com/opensearch-project/OpenSearch/blob/3.0.0/server/src/main/java/org/opensearch/cluster/coordination/ClusterBootstrapService.java#L126-L136>
235235
String::new()
236236
}
237237
}

0 commit comments

Comments
 (0)