Skip to content

Commit

Permalink
docs: use backticks for all type links
Browse files Browse the repository at this point in the history
Signed-off-by: Nathaniel McCallum <nathaniel@profian.com>
  • Loading branch information
npmccallum committed Apr 20, 2022
1 parent af91968 commit cce2b5a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions axum-core/src/response/mod.rs
Expand Up @@ -20,15 +20,15 @@ pub use self::{
/// type used with axum.
pub type Response<T = BoxBody> = http::Response<T>;

/// A flexible [IntoResponse]-based result type
/// A flexible [`IntoResponse`]-based result type
///
/// All types which implement [IntoResponse] can be converted to an [ErrorResponse].
/// All types which implement [`IntoResponse`] can be converted to an [`ErrorResponse`].
/// This makes it useful as a general error type for functions which combine
/// multiple distinct error types but all of which implement [IntoResponse].
/// multiple distinct error types but all of which implement [`IntoResponse`].
///
/// For example, note that the error types below differ. However, both can be
/// used with the [Result], and therefore the `?` operator, since they both
/// implement [IntoResponse].
/// used with the [`Result`], and therefore the `?` operator, since they both
/// implement [`IntoResponse`].
///
/// ```no_run
/// use axum::{
Expand Down Expand Up @@ -64,9 +64,9 @@ where
}
}

/// An [IntoResponse]-based error type
/// An [`IntoResponse`]-based error type
///
/// See [Result] for more details.
/// See [`Result`] for more details.
#[derive(Debug)]
pub struct ErrorResponse(Response);

Expand Down

0 comments on commit cce2b5a

Please sign in to comment.