From e1dcf51d7009ff1448baabf11f62de792278f0f1 Mon Sep 17 00:00:00 2001 From: Nick Sippl-Swezey Date: Wed, 18 Oct 2023 16:13:11 -0700 Subject: [PATCH] fixes doc linting error: redundant explicit link target error: redundant explicit link target --> scylla/src/lib.rs:16:55 | 16 | //! All driver activity revolves around the [Session](crate::Session)\ | ------- ^^^^^^^^^^^^^^ explicit target is redundant | | | because label contains path that resolves to same destination | = note: when a link's destination is not specified, the label is used to resolve intra-doc links = note: `-D rustdoc::redundant-explicit-links` implied by `-D warnings` help: remove explicit link target fixes: https://github.com/scylladb/scylla-rust-driver/issues/847 --- scylla/src/lib.rs | 4 ++-- scylla/src/statement/batch.rs | 2 +- scylla/src/statement/prepared_statement.rs | 2 +- scylla/src/statement/query.rs | 2 +- scylla/src/transport/host_filter.rs | 2 +- scylla/src/transport/session.rs | 14 +++++++------- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/scylla/src/lib.rs b/scylla/src/lib.rs index b1c8770eb0..27a3c57471 100644 --- a/scylla/src/lib.rs +++ b/scylla/src/lib.rs @@ -13,7 +13,7 @@ //! //! # Driver overview //! ### Connecting -//! All driver activity revolves around the [Session](crate::Session)\ +//! All driver activity revolves around the [Session]\ //! `Session` is created by specifying a few known nodes and connecting to them: //! //! ```rust,no_run @@ -31,7 +31,7 @@ //! Ok(()) //! } //! ``` -//! `Session` is usually created using the [SessionBuilder](crate::SessionBuilder).\ +//! `Session` is usually created using the [SessionBuilder].\ //! All configuration options for a `Session` can be specified while building. //! //! ### Making queries diff --git a/scylla/src/statement/batch.rs b/scylla/src/statement/batch.rs index 58d8ce411b..6805dcb275 100644 --- a/scylla/src/statement/batch.rs +++ b/scylla/src/statement/batch.rs @@ -76,7 +76,7 @@ impl Batch { /// A query is idempotent if it can be applied multiple times without changing the result of the initial application /// If set to `true` we can be sure that it is idempotent /// If set to `false` it is unknown whether it is idempotent - /// This is used in [`RetryPolicy`](crate::retry_policy::RetryPolicy) to decide if retrying a query is safe + /// This is used in [`RetryPolicy`] to decide if retrying a query is safe pub fn set_is_idempotent(&mut self, is_idempotent: bool) { self.config.is_idempotent = is_idempotent; } diff --git a/scylla/src/statement/prepared_statement.rs b/scylla/src/statement/prepared_statement.rs index 9814e7350d..22f34e60a2 100644 --- a/scylla/src/statement/prepared_statement.rs +++ b/scylla/src/statement/prepared_statement.rs @@ -239,7 +239,7 @@ impl PreparedStatement { /// A query is idempotent if it can be applied multiple times without changing the result of the initial application /// If set to `true` we can be sure that it is idempotent /// If set to `false` it is unknown whether it is idempotent - /// This is used in [`RetryPolicy`](crate::retry_policy::RetryPolicy) to decide if retrying a query is safe + /// This is used in [`RetryPolicy`] to decide if retrying a query is safe pub fn set_is_idempotent(&mut self, is_idempotent: bool) { self.config.is_idempotent = is_idempotent; } diff --git a/scylla/src/statement/query.rs b/scylla/src/statement/query.rs index 956b645833..913aebd1d7 100644 --- a/scylla/src/statement/query.rs +++ b/scylla/src/statement/query.rs @@ -76,7 +76,7 @@ impl Query { /// A query is idempotent if it can be applied multiple times without changing the result of the initial application /// If set to `true` we can be sure that it is idempotent /// If set to `false` it is unknown whether it is idempotent - /// This is used in [`RetryPolicy`](crate::retry_policy::RetryPolicy) to decide if retrying a query is safe + /// This is used in [`RetryPolicy`] to decide if retrying a query is safe pub fn set_is_idempotent(&mut self, is_idempotent: bool) { self.config.is_idempotent = is_idempotent; } diff --git a/scylla/src/transport/host_filter.rs b/scylla/src/transport/host_filter.rs index d59f90a49a..2838f1733c 100644 --- a/scylla/src/transport/host_filter.rs +++ b/scylla/src/transport/host_filter.rs @@ -1,7 +1,7 @@ //! Host filters. //! //! Host filters are essentially just a predicate over -//! [`Peer`](crate::transport::topology::Peer)s. Currently, they are used +//! [`Peer`]s. Currently, they are used //! by the [`Session`](crate::transport::session::Session) to determine whether //! connections should be opened to a given node or not. diff --git a/scylla/src/transport/session.rs b/scylla/src/transport/session.rs index 2f67874f8c..24cc481c93 100644 --- a/scylla/src/transport/session.rs +++ b/scylla/src/transport/session.rs @@ -561,7 +561,7 @@ impl Session { /// /// See [the book](https://rust-driver.docs.scylladb.com/stable/queries/simple.html) for more information /// # Arguments - /// * `query` - query to perform, can be just a `&str` or the [Query](crate::query::Query) struct. + /// * `query` - query to perform, can be just a `&str` or the [Query] struct. /// * `values` - values bound to the query, easiest way is to use a tuple of bound values /// /// # Examples @@ -732,12 +732,12 @@ impl Session { /// This method will query all pages of the result\ /// /// Returns an async iterator (stream) over all received rows\ - /// Page size can be specified in the [Query](crate::query::Query) passed to the function + /// Page size can be specified in the [Query] passed to the function /// /// See [the book](https://rust-driver.docs.scylladb.com/stable/queries/paged.html) for more information /// /// # Arguments - /// * `query` - query to perform, can be just a `&str` or the [Query](crate::query::Query) struct. + /// * `query` - query to perform, can be just a `&str` or the [Query] struct. /// * `values` - values bound to the query, easiest way is to use a tuple of bound values /// /// # Example @@ -799,7 +799,7 @@ impl Session { /// See [the book](https://rust-driver.docs.scylladb.com/stable/queries/prepared.html) for more information /// /// # Arguments - /// * `query` - query to prepare, can be just a `&str` or the [Query](crate::query::Query) struct. + /// * `query` - query to prepare, can be just a `&str` or the [Query] struct. /// /// # Example /// ```rust @@ -876,7 +876,7 @@ impl Session { .as_deref() } - /// Execute a prepared query. Requires a [PreparedStatement](crate::prepared_statement::PreparedStatement) + /// Execute a prepared query. Requires a [PreparedStatement] /// generated using [`Session::prepare`](Session::prepare)\ /// Returns only a single page of results, to receive multiple pages use [execute_iter](Session::execute_iter) /// @@ -1036,7 +1036,7 @@ impl Session { /// This method will query all pages of the result\ /// /// Returns an async iterator (stream) over all received rows\ - /// Page size can be specified in the [PreparedStatement](crate::prepared_statement::PreparedStatement) + /// Page size can be specified in the [PreparedStatement] /// passed to the function /// /// See [the book](https://rust-driver.docs.scylladb.com/stable/queries/paged.html) for more information @@ -1105,7 +1105,7 @@ impl Session { /// See [the book](https://rust-driver.docs.scylladb.com/stable/queries/batch.html) for more information /// /// # Arguments - /// * `batch` - [Batch](crate::batch::Batch) to be performed + /// * `batch` - [Batch] to be performed /// * `values` - List of values for each query, it's the easiest to use a tuple of tuples /// /// # Example