From 670db1db4bbd736e02ec80a0042ea0f5301e9721 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Tue, 25 Jul 2023 18:34:26 +0300 Subject: [PATCH] `pycodestyle.max-doc-length` doc updates (#6052) --- .../ruff/src/rules/pycodestyle/rules/doc_line_too_long.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/crates/ruff/src/rules/pycodestyle/rules/doc_line_too_long.rs b/crates/ruff/src/rules/pycodestyle/rules/doc_line_too_long.rs index 701a3edbd9..5fe7d8e2fc 100644 --- a/crates/ruff/src/rules/pycodestyle/rules/doc_line_too_long.rs +++ b/crates/ruff/src/rules/pycodestyle/rules/doc_line_too_long.rs @@ -22,6 +22,11 @@ use crate::settings::Settings; /// characters), and lines that end with a URL (as long as the URL starts /// before the line-length threshold). /// +/// Note that this rule will only be enforced after providing a value for +/// [`pycodestyle.max-doc-length`] in your Ruff configuration file. If no +/// value is provided, this rule will be ignored, even if it's added to your +/// `--select` list. +/// /// If [`pycodestyle.ignore-overlong-task-comments`] is `true`, this rule will /// also ignore comments that start with any of the specified [`task-tags`] /// (e.g., `# TODO:`). @@ -43,6 +48,7 @@ use crate::settings::Settings; /// /// ## Options /// - `task-tags` +/// - `pycodestyle.max-doc-length` /// - `pycodestyle.ignore-overlong-task-comments` /// /// [PEP 8]: https://peps.python.org/pep-0008/#maximum-line-length