From 7d0bb28876fb958154590df6f5470de48c18408f Mon Sep 17 00:00:00 2001 From: walfie Date: Tue, 22 Nov 2022 02:08:18 -0500 Subject: [PATCH] Minor doc fixes (#1562) --- axum-extra/src/extract/query.rs | 2 +- axum/src/extract/query.rs | 2 +- axum/src/extract/state.rs | 2 +- axum/src/handler/into_service_state_in_extension.rs | 2 +- axum/src/handler/service.rs | 2 +- axum/src/lib.rs | 4 ++-- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/axum-extra/src/extract/query.rs b/axum-extra/src/extract/query.rs index 8c829dd5fc..6e046b39ce 100644 --- a/axum-extra/src/extract/query.rs +++ b/axum-extra/src/extract/query.rs @@ -49,7 +49,7 @@ use std::{fmt, ops::Deref}; /// If the query string cannot be parsed it will reject the request with a `422 /// Unprocessable Entity` response. /// -/// For handling values being empty vs missing see the (query-params-with-empty-strings)[example] +/// For handling values being empty vs missing see the [query-params-with-empty-strings][example] /// example. /// /// [example]: https://github.com/tokio-rs/axum/blob/main/examples/query-params-with-empty-strings/src/main.rs diff --git a/axum/src/extract/query.rs b/axum/src/extract/query.rs index 23cb02dc7a..fd89820a24 100644 --- a/axum/src/extract/query.rs +++ b/axum/src/extract/query.rs @@ -41,7 +41,7 @@ use std::ops::Deref; /// If the query string cannot be parsed it will reject the request with a `422 /// Unprocessable Entity` response. /// -/// For handling values being empty vs missing see the (query-params-with-empty-strings)[example] +/// For handling values being empty vs missing see the [query-params-with-empty-strings][example] /// example. /// /// [example]: https://github.com/tokio-rs/axum/blob/main/examples/query-params-with-empty-strings/src/main.rs diff --git a/axum/src/extract/state.rs b/axum/src/extract/state.rs index 966d72a014..89a4ceb9fd 100644 --- a/axum/src/extract/state.rs +++ b/axum/src/extract/state.rs @@ -8,7 +8,7 @@ use std::{ /// Extractor for state. /// -/// See ["Accessing state in middleware"][state-from-middleware] for how to +/// See ["Accessing state in middleware"][state-from-middleware] for how to /// access state in middleware. /// /// [state-from-middleware]: crate::middleware#accessing-state-in-middleware diff --git a/axum/src/handler/into_service_state_in_extension.rs b/axum/src/handler/into_service_state_in_extension.rs index 4e6a3f2456..61f7ed4351 100644 --- a/axum/src/handler/into_service_state_in_extension.rs +++ b/axum/src/handler/into_service_state_in_extension.rs @@ -62,7 +62,7 @@ where #[inline] fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll> { // `IntoServiceStateInExtension` can only be constructed from async functions which are always ready, or - // from `Layered` which bufferes in `::call` and is therefore + // from `Layered` which buffers in `::call` and is therefore // also always ready. Poll::Ready(Ok(())) } diff --git a/axum/src/handler/service.rs b/axum/src/handler/service.rs index 05b9b0182e..52fd5de67d 100644 --- a/axum/src/handler/service.rs +++ b/axum/src/handler/service.rs @@ -159,7 +159,7 @@ where #[inline] fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll> { // `IntoService` can only be constructed from async functions which are always ready, or - // from `Layered` which bufferes in `::call` and is therefore + // from `Layered` which buffers in `::call` and is therefore // also always ready. Poll::Ready(Ok(())) } diff --git a/axum/src/lib.rs b/axum/src/lib.rs index 5d2a8de0cd..d3a1be4b81 100644 --- a/axum/src/lib.rs +++ b/axum/src/lib.rs @@ -94,7 +94,7 @@ //! //! # Extractors //! -//! An extractor is a type that implements [`FromRequest`] or [`FromRequestParts`]. Extractors is +//! An extractor is a type that implements [`FromRequest`] or [`FromRequestParts`]. Extractors are //! how you pick apart the incoming request to get the parts your handler needs. //! //! ```rust @@ -204,7 +204,7 @@ //! ``` //! //! You should prefer using [`State`] if possible since it's more type safe. The downside is that -//! its less dynamic than request extensions. +//! it's less dynamic than request extensions. //! //! See [`State`] for more details about accessing state. //!