From b52a3586a77360aed71ba5d1fd5c3ca4b992aebf Mon Sep 17 00:00:00 2001 From: "Carol (Nichols || Goulding)" <193874+carols10cents@users.noreply.github.com> Date: Sat, 28 May 2022 07:24:22 -0400 Subject: [PATCH] fix: Turn cargo doc warnings into errors (#4710) * fix: Correct intra-doc links * fix: Turn cargo doc warnings into errors Co-authored-by: Jake Goulding Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- .circleci/config.yml | 2 ++ ioxd_querier/src/rpc/namespace.rs | 2 +- query_functions/src/selectors.rs | 2 +- service_grpc_influxrpc/src/service.rs | 2 +- test_helpers_end_to_end/src/config.rs | 4 ++-- test_helpers_end_to_end/src/mini_cluster.rs | 2 +- 6 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 6186ea33b5..781cebb612 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -140,6 +140,8 @@ jobs: RUSTFLAGS: "-C debuginfo=1" # https://github.com/rust-lang/cargo/issues/10280 CARGO_NET_GIT_FETCH_WITH_CLI: "true" + # Turn warnings into errors + RUSTDOCFLAGS: "-D warnings -A rustdoc::private-intra-doc-links" steps: - checkout - rust_components diff --git a/ioxd_querier/src/rpc/namespace.rs b/ioxd_querier/src/rpc/namespace.rs index be2fd9c8c0..0649ccbff2 100644 --- a/ioxd_querier/src/rpc/namespace.rs +++ b/ioxd_querier/src/rpc/namespace.rs @@ -5,7 +5,7 @@ use generated_types::influxdata::iox::namespace::v1 as proto; use querier::QuerierDatabase; use std::sync::Arc; -/// Acquire a [`NamespaceService`] gRPC service implementation. +/// Acquire a [`NamespaceService`](proto::namespace_service_server::NamespaceService) gRPC service implementation. pub fn namespace_service( server: Arc, ) -> proto::namespace_service_server::NamespaceServiceServer< diff --git a/query_functions/src/selectors.rs b/query_functions/src/selectors.rs index 668565633a..a2babbae77 100644 --- a/query_functions/src/selectors.rs +++ b/query_functions/src/selectors.rs @@ -173,7 +173,7 @@ trait Selector: Debug + Default + Send + Sync { } /// Describes which part of the selector to return: the timestamp or -/// the value (when https://issues.apache.org/jira/browse/ARROW-10945 +/// the value (when /// is fixed, this enum should be removed) #[derive(Debug, Clone, Copy)] pub enum SelectorOutput { diff --git a/service_grpc_influxrpc/src/service.rs b/service_grpc_influxrpc/src/service.rs index edc87a94b8..f07cacb200 100644 --- a/service_grpc_influxrpc/src/service.rs +++ b/service_grpc_influxrpc/src/service.rs @@ -1,5 +1,5 @@ //! This module contains implementations for the storage gRPC service -//! implemented in terms of the [`QueryDatabase`](query::QueryDatabase). +//! implemented in terms of the [`QueryDatabase`](iox_query::QueryDatabase). use super::{TAG_KEY_FIELD, TAG_KEY_MEASUREMENT}; use crate::{ diff --git a/test_helpers_end_to_end/src/config.rs b/test_helpers_end_to_end/src/config.rs index ce86fba1c4..6f01459bc9 100644 --- a/test_helpers_end_to_end/src/config.rs +++ b/test_helpers_end_to_end/src/config.rs @@ -33,8 +33,8 @@ pub struct TestConfig { } impl TestConfig { - /// Create a new TestConfig (tests should use one of the specific - /// configuration setup below, such as [new_router] + /// Create a new TestConfig. Tests should use one of the specific + /// configuration setup below, such as [new_router](Self::new_router). fn new( server_type: ServerType, dsn: impl Into, diff --git a/test_helpers_end_to_end/src/mini_cluster.rs b/test_helpers_end_to_end/src/mini_cluster.rs index 7988d96de7..985d405c41 100644 --- a/test_helpers_end_to_end/src/mini_cluster.rs +++ b/test_helpers_end_to_end/src/mini_cluster.rs @@ -54,7 +54,7 @@ impl MiniCluster { /// servers but has a new unique namespace and set of connections /// /// Note this is an internal implementation -- please use - /// [create_shared], and [new] to create new MiniClusters. + /// [`create_shared`](Self::create_shared), and [`new`](Self::new) to create new MiniClusters. fn new_from_fixtures( router: Option, ingester: Option,