chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api: Rewrap doc comment

Browse Source
This commit is contained in:
Jonas Platte 2021-08-22 22:14:32 +02:00
parent f3e52e4bc3
commit 35a231e20c
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
crates/ruma-api/src/lib.rs
View File

@ -78,10 +78,9 @@ use ruma_identifiers::UserId;
///
/// ## Request
///
/// The request block contains normal struct field definitions.
/// Doc comments and attributes are allowed as normal.
/// There are also a few special attributes available to control how the struct is converted
/// into a `http::Request`:
/// The request block contains normal struct field definitions. Doc comments and attributes are
/// allowed as normal. There are also a few special attributes available to control how the
/// struct is converted into an `http::Request`:
///
/// * `#[ruma_api(header = HEADER_NAME)]`: Fields with this attribute will be treated as HTTP
/// headers on the request. The value must implement `AsRef<str>`. Generally this is a