actix/actix-web
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-web synced 2024-11-27 09:42:57 +01:00
Code Issues Releases Wiki Activity

docs: fix long paragraph warning

Browse Source
This commit is contained in:
Rob Ede 2024-10-07 21:23:17 +01:00
parent b7a0ff0a3a
commit 049b49290d
No known key found for this signature in database
GPG Key ID: 97C636207D3EF933
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
actix-web/src/http/header/content_disposition.rs
View File

@ -206,11 +206,11 @@ impl DispositionParam {
} }
} }
/// A *Content-Disposition* header. It is compatible to be used either as /// `Content-Disposition` header.
/// [a response header for the main body](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#as_a_response_header_for_the_main_body) ///
/// as (re)defined in [RFC 6266](https://datatracker.ietf.org/doc/html/rfc6266), or as /// It is compatible to be used either as [a response header for the main body][use_main_body]
/// [a header for a multipart body](https://mdn.io/Content-Disposition#As_a_header_for_a_multipart_body) /// as (re)defined in [RFC 6266], or as [a header for a multipart body][use_multipart] as
/// as (re)defined in [RFC 7587](https://datatracker.ietf.org/doc/html/rfc7578). /// (re)defined in [RFC 7587].
/// ///
/// In a regular HTTP response, the *Content-Disposition* response header is a header indicating if /// In a regular HTTP response, the *Content-Disposition* response header is a header indicating if
/// the content is expected to be displayed *inline* in the browser, that is, as a Web page or as /// the content is expected to be displayed *inline* in the browser, that is, as a Web page or as
@ -305,6 +305,11 @@ impl DispositionParam {
/// change to match local file system conventions if applicable, and do not use directory path /// change to match local file system conventions if applicable, and do not use directory path
/// information that may be present. /// information that may be present.
/// See [RFC 2183 §2.3](https://datatracker.ietf.org/doc/html/rfc2183#section-2.3). /// See [RFC 2183 §2.3](https://datatracker.ietf.org/doc/html/rfc2183#section-2.3).
///
/// [use_main_body]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#as_a_response_header_for_the_main_body
/// [RFC 6266]: https://datatracker.ietf.org/doc/html/rfc6266
/// [use_multipart]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#as_a_header_for_a_multipart_body
/// [RFC 7587]: https://datatracker.ietf.org/doc/html/rfc7578
#[derive(Debug, Clone, PartialEq, Eq)] #[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContentDisposition { pub struct ContentDisposition {
/// The disposition type /// The disposition type

1
justfile
View File

@ -73,6 +73,7 @@ test-coverage-lcov toolchain="": (test-coverage toolchain)
# Document crates in workspace. # Document crates in workspace.
doc *args: && doc-set-workspace-crates doc *args: && doc-set-workspace-crates
rm -f "$(cargo metadata --format-version=1 | jq -r '.target_directory')/doc/crates.js"
RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --workspace {{ all_crate_features }} {{ args }} RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --workspace {{ all_crate_features }} {{ args }}
[private] [private]