about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJason Newcomb <jsnewcomb@pm.me>2024-07-27 18:17:26 -0400
committerJason Newcomb <jsnewcomb@pm.me>2024-07-27 18:17:26 -0400
commit84dc56923bb24743ae10c737e0022bcc87f222ac (patch)
tree2b196d666693618bd3c8b246097378e7e11cb79e
parenta54e3130ca1c895f8c3757e3bb1a9a85f659ccfd (diff)
downloadrust-84dc56923bb24743ae10c737e0022bcc87f222ac.tar.gz
rust-84dc56923bb24743ae10c737e0022bcc87f222ac.zip
Add docs for `await_holding_invalid_types`
-rw-r--r--book/src/lint_configuration.md2
-rw-r--r--clippy_config/src/conf.rs2
2 files changed, 3 insertions, 1 deletions
diff --git a/book/src/lint_configuration.md b/book/src/lint_configuration.md
index fb717a2c166..aaf58956a8b 100644
--- a/book/src/lint_configuration.md
+++ b/book/src/lint_configuration.md
@@ -364,7 +364,7 @@ Suppress lints whenever the suggested change would cause breakage for other crat
 
 
 ## `await-holding-invalid-types`
-
+The list of types which may not be held across an await point.
 
 **Default Value:** `[]`
 
diff --git a/clippy_config/src/conf.rs b/clippy_config/src/conf.rs
index 7d75bdd1b62..2aeca6d0f90 100644
--- a/clippy_config/src/conf.rs
+++ b/clippy_config/src/conf.rs
@@ -416,6 +416,8 @@ define_Conf! {
     /// Suppress lints whenever the suggested change would cause breakage for other crates.
     (avoid_breaking_exported_api: bool = true),
     /// Lint: AWAIT_HOLDING_INVALID_TYPE.
+    ///
+    /// The list of types which may not be held across an await point.
     (await_holding_invalid_types: Vec<DisallowedPath> = Vec::new()),
     /// DEPRECATED LINT: BLACKLISTED_NAME.
     ///