From e07f1a8b9c33c9e266e83c90376a822a4ad16628 Mon Sep 17 00:00:00 2001 From: link2xt Date: Thu, 17 Oct 2024 10:54:24 +0000 Subject: [PATCH] docs: fix `too_long_first_doc_paragraph` clippy lint This lint is enabled for beta and nightly Rust. --- src/constants.rs | 4 +++- src/message.rs | 1 + src/quota.rs | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/constants.rs b/src/constants.rs index 72cda9b15..085137341 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -179,7 +179,9 @@ pub const DC_DESIRED_TEXT_LEN: usize = DC_DESIRED_TEXT_LINE_LEN * DC_DESIRED_TEX // and may be set together with the username, password etc. // via dc_set_config() using the key "server_flags". -/// Force OAuth2 authorization. This flag does not skip automatic configuration. +/// Force OAuth2 authorization. +/// +/// This flag does not skip automatic configuration. /// Before calling configure() with DC_LP_AUTH_OAUTH2 set, /// the user has to confirm access at the URL returned by dc_get_oauth2_url(). pub const DC_LP_AUTH_OAUTH2: i32 = 0x2; diff --git a/src/message.rs b/src/message.rs index 92c5b5c16..99a780247 100644 --- a/src/message.rs +++ b/src/message.rs @@ -1915,6 +1915,7 @@ pub async fn get_request_msg_cnt(context: &Context) -> usize { /// Estimates the number of messages that will be deleted /// by the options `delete_device_after` or `delete_server_after`. +/// /// This is typically used to show the estimated impact to the user /// before actually enabling deletion of old messages. /// diff --git a/src/quota.rs b/src/quota.rs index 4b874c3df..9680a2046 100644 --- a/src/quota.rs +++ b/src/quota.rs @@ -25,6 +25,7 @@ pub const QUOTA_ERROR_THRESHOLD_PERCENTAGE: u64 = 95; /// if quota is below this value (again), /// QuotaExceeding is cleared. +/// /// This value should be a bit below QUOTA_WARN_THRESHOLD_PERCENTAGE to /// avoid jittering and lots of warnings when quota is exactly at the warning threshold. ///