From 3e34cda48a4750905a244e313cb4ab26bb4fd2e4 Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Tue, 19 Jul 2022 18:04:11 +0200 Subject: [PATCH] client-api: Add more docs to `get_message_events::Request`s constructors --- crates/ruma-client-api/src/message/get_message_events.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/crates/ruma-client-api/src/message/get_message_events.rs b/crates/ruma-client-api/src/message/get_message_events.rs index 25334134..fae841f1 100644 --- a/crates/ruma-client-api/src/message/get_message_events.rs +++ b/crates/ruma-client-api/src/message/get_message_events.rs @@ -112,6 +112,9 @@ pub mod v3 { /// Creates a new `Request` with the given room ID and `dir` set to `Backward`. /// + /// If the returned request is sent without `from` being set, pagination will start at the + /// end of (the accessible part of) the room timeline. + /// /// # Example /// /// ```rust @@ -126,6 +129,9 @@ pub mod v3 { /// Creates a new `Request` with the given room ID and `dir` set to `Forward`. /// + /// If the returned request is sent without `from` being set, pagination will start at the + /// beginning of (the accessible part of) the room timeline. + /// /// # Example /// /// ```rust