From 56d2623b7dcc8fc38bfb2cceeef589c91cae6f5d Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Thu, 3 Sep 2020 21:22:47 +0200 Subject: [PATCH] client-api: Improve docs for contains_url in RoomEventFilter --- ruma-client-api/src/r0/filter.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/ruma-client-api/src/r0/filter.rs b/ruma-client-api/src/r0/filter.rs index 05aa03ac..c1de1764 100644 --- a/ruma-client-api/src/r0/filter.rs +++ b/ruma-client-api/src/r0/filter.rs @@ -74,10 +74,11 @@ pub struct RoomEventFilter<'a> { #[serde(default, skip_serializing_if = "Option::is_none")] pub types: Option<&'a [String]>, - /// If `true` include only events with a URL key in their content. - /// If `false`, exclude such events. + /// Controls whether to include events with a URL key in their content. /// - /// If this item is absent then all event types are included. + /// * `None`: No filtering + /// * `Some(true)`: Only events with a URL + /// * `Some(false)`: Only events without a URL #[serde(skip_serializing_if = "Option::is_none")] pub contains_url: Option,