mirror of
https://github.com/tokio-rs/axum.git
synced 2024-12-03 13:36:58 +01:00
Some documentation fixes (#3027)
This commit is contained in:
parent
8bc326cc3d
commit
da4580247a
7 changed files with 10 additions and 9 deletions
|
@ -57,4 +57,3 @@ allowed = [
|
|||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
|
|
@ -42,7 +42,7 @@ define_rejection! {
|
|||
#[body = "Failed to buffer the request body"]
|
||||
/// Encountered some other error when buffering the body.
|
||||
///
|
||||
/// This can _only_ happen when you're using [`tower_http::limit::RequestBodyLimitLayer`] or
|
||||
/// This can _only_ happen when you're using [`tower_http::limit::RequestBodyLimitLayer`] or
|
||||
/// otherwise wrapping request bodies in [`http_body_util::Limited`].
|
||||
pub struct LengthLimitError(Error);
|
||||
}
|
||||
|
|
|
@ -84,7 +84,6 @@ tower-http = { version = "0.6.0", features = ["map-response-body", "timeout"] }
|
|||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
||||
[package.metadata.cargo-public-api-crates]
|
||||
allowed = [
|
||||
|
|
|
@ -75,7 +75,7 @@ use std::{
|
|||
/// to keep `Field`s around from previous loop iterations. That will minimize the risk of runtime
|
||||
/// errors.
|
||||
///
|
||||
/// # Differences between this and `axum::extract::Multipart`
|
||||
/// # Differences between this and `axum::extract::Multipart`
|
||||
///
|
||||
/// `axum::extract::Multipart` uses lifetimes to enforce field exclusivity at compile time, however
|
||||
/// that leads to significant usability issues such as `Field` not being `'static`.
|
||||
|
|
|
@ -23,7 +23,7 @@
|
|||
//! `query` | Enables the `Query` extractor | No
|
||||
//! `tracing` | Log rejections from built-in extractors | Yes
|
||||
//! `typed-routing` | Enables the `TypedPath` routing utilities | No
|
||||
//! `typed-header` | Enables the `TypedHeader` extractor and response | No
|
||||
//! `typed-header` | Enables the `TypedHeader` extractor and response | No
|
||||
//!
|
||||
//! [`axum`]: https://crates.io/crates/axum
|
||||
|
||||
|
|
|
@ -43,4 +43,3 @@ allowed = []
|
|||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
|
|
@ -37,8 +37,13 @@ tower-log = ["tower/log"]
|
|||
tracing = ["dep:tracing", "axum-core/tracing"]
|
||||
ws = ["dep:hyper", "tokio", "dep:tokio-tungstenite", "dep:sha1", "dep:base64"]
|
||||
|
||||
# Required for intra-doc links to resolve correctly
|
||||
__private_docs = ["tower/full", "dep:tower-http"]
|
||||
__private_docs = [
|
||||
# We re-export some docs from axum-core via #[doc(inline)],
|
||||
# but they need the same sort of treatment as below to be complete
|
||||
"axum-core/__private_docs",
|
||||
# Enables upstream things linked to in docs
|
||||
"tower/full", "dep:tower-http",
|
||||
]
|
||||
|
||||
[dependencies]
|
||||
async-trait = "0.1.67"
|
||||
|
@ -128,7 +133,6 @@ uuid = { version = "1.0", features = ["serde", "v4"] }
|
|||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
||||
[dev-dependencies.tower]
|
||||
package = "tower"
|
||||
|
|
Loading…
Reference in a new issue