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

events: Fix some docs being on wrong constructor

Browse Source
This commit is contained in:
Jonas Platte 2021-11-19 10:49:11 +01:00
parent 49e5d45ac9
commit 897146e369
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/ruma-events/src/room/message.rs
View File

@ -125,11 +125,6 @@ impl RoomMessageEventContent {
} }
/// Creates a plain text notice reply to a message. /// Creates a plain text notice reply to a message.
///
/// Different from `notice_reply_plain`, this constructor requires specifically a
/// [`RoomMessageEvent`] since it creates a permalink to the previous message, for which the
/// room ID is required. If you want to reply to a [`SyncRoomMessageEvent`], you have to convert
/// it first by calling [`.into_full_event()`][crate::SyncMessageEvent::into_full_event].
pub fn notice_reply_plain( pub fn notice_reply_plain(
reply: impl fmt::Display, reply: impl fmt::Display,
original_message: &impl ReplyBaseEvent, original_message: &impl ReplyBaseEvent,
@ -146,6 +141,11 @@ impl RoomMessageEventContent {
} }
/// Creates a html text notice reply to a message. /// Creates a html text notice reply to a message.
///
/// Different from `notice_reply_plain`, this constructor requires specifically a
/// [`RoomMessageEvent`] since it creates a permalink to the previous message, for which the
/// room ID is required. If you want to reply to a [`SyncRoomMessageEvent`], you have to convert
/// it first by calling [`.into_full_event()`][crate::SyncMessageEvent::into_full_event].
pub fn notice_reply_html( pub fn notice_reply_html(
reply: impl fmt::Display, reply: impl fmt::Display,
html_reply: impl fmt::Display, html_reply: impl fmt::Display,