Skip to content

Commit

Permalink
fixes doc linting error: redundant explicit link target
Browse files Browse the repository at this point in the history
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: scylladb#847
  • Loading branch information
nsipplswezey committed Oct 19, 2023
1 parent 82c1c99 commit e1dcf51
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions scylla/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion scylla/src/statement/batch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion scylla/src/statement/prepared_statement.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion scylla/src/statement/query.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion scylla/src/transport/host_filter.rs
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
14 changes: 7 additions & 7 deletions scylla/src/transport/session.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)
///
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit e1dcf51

Please sign in to comment.