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

client-api: Clean up get_message_events docs

Browse Source
This commit is contained in:
Jonas Platte 2022-03-25 10:14:24 +01:00
parent 22239c39fc
commit c32e074383
No known key found for this signature in database
GPG Key ID: BBA95679259D342F
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
crates/ruma-client-api/src/message/get_message_events.rs
View File

@ -35,17 +35,17 @@ pub mod v3 {
/// The token to start returning events from. /// The token to start returning events from.
/// ///
/// This token can be obtained from a /// This token can be obtained from a `prev_batch` token returned for each room by the
/// prev_batch token returned for each room by the sync API, or from a start or end token /// sync endpoint, or from a `start` or `end` token returned by a previous request to
/// returned by a previous request to this endpoint. /// this endpoint.
#[ruma_api(query)] #[ruma_api(query)]
pub from: &'a str, pub from: &'a str,
/// The token to stop returning events at. /// The token to stop returning events at.
/// ///
/// This token can be obtained from a prev_batch /// This token can be obtained from a `prev_batch` token returned for each room by the
/// token returned for each room by the sync endpoint, or from a start or end token returned /// sync endpoint, or from a `start` or `end` token returned by a previous request to
/// by a previous request to this endpoint. /// this endpoint.
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)] #[ruma_api(query)]
pub to: Option<&'a str>, pub to: Option<&'a str>,
@ -56,12 +56,12 @@ pub mod v3 {
/// The maximum number of events to return. /// The maximum number of events to return.
/// ///
/// Default: 10. /// Default: `10`.
#[ruma_api(query)] #[ruma_api(query)]
#[serde(default = "default_limit", skip_serializing_if = "is_default_limit")] #[serde(default = "default_limit", skip_serializing_if = "is_default_limit")]
pub limit: UInt, pub limit: UInt,
/// A RoomEventFilter to filter returned events with. /// A `RoomEventFilter` to filter returned events with.
#[ruma_api(query)] #[ruma_api(query)]
#[serde( #[serde(
with = "ruma_common::serde::json_string", with = "ruma_common::serde::json_string",