From bb08eea5cc9d92a3aaa50482bb0d5b3a9beea2b0 Mon Sep 17 00:00:00 2001
From: rembridge <35376887+arembridge@users.noreply.github.com>
Date: Thu, 27 Jul 2023 19:52:43 +0100
Subject: [PATCH] missing-whitespace-around-operators comment (#6106)

**Summary**

Updated doc comments for `missing_whitespace_around_operator.rs`. Online
docs also benefit from this update.

**Test Plan**

Checked docs via
[mkdocs](https://github.com/astral-sh/ruff/blob/389fe13c934fe73679474006412b1eded4a2cad0/CONTRIBUTING.md?plain=1#L267-L296)
---
 .../missing_whitespace_around_operator.rs     | 74 +++++++++++++++++++
 scripts/check_docs_formatted.py               |  4 +
 2 files changed, 78 insertions(+)

diff --git a/crates/ruff/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_around_operator.rs b/crates/ruff/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_around_operator.rs
index 61e2c17d89..a32a4e4bd9 100644
--- a/crates/ruff/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_around_operator.rs
+++ b/crates/ruff/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_around_operator.rs
@@ -5,6 +5,26 @@ use ruff_python_parser::TokenKind;
 use crate::checkers::logical_lines::LogicalLinesContext;
 use crate::rules::pycodestyle::rules::logical_lines::LogicalLine;
 
+/// ## What it does
+/// Checks for missing whitespace around all operators.
+///
+/// ## Why is this bad?
+/// According to [PEP 8], there should be one space before and after all
+/// operators.
+///
+/// ## Example
+/// ```python
+/// if number==42:
+///     print('you have found the meaning of life')
+/// ```
+///
+/// Use instead:
+/// ```python
+/// if number == 42:
+///     print('you have found the meaning of life')
+/// ```
+///
+/// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves
 // E225
 #[violation]
 pub struct MissingWhitespaceAroundOperator;
@@ -16,6 +36,24 @@ impl Violation for MissingWhitespaceAroundOperator {
     }
 }
 
+/// ## What it does
+/// Checks for missing whitespace arithmetic operators.
+///
+/// ## Why is this bad?
+/// According to [PEP 8], there should be one space before and after an
+/// arithmetic operator (+, -, /, and *).
+///
+/// ## Example
+/// ```python
+/// number = 40+2
+/// ```
+///
+/// Use instead:
+/// ```python
+/// number = 40 + 2
+/// ```
+///
+/// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves
 // E226
 #[violation]
 pub struct MissingWhitespaceAroundArithmeticOperator;
@@ -27,6 +65,24 @@ impl Violation for MissingWhitespaceAroundArithmeticOperator {
     }
 }
 
+/// ## What it does
+/// Checks for missing whitespace around bitwise and shift operators.
+///
+/// ## Why is this bad?
+/// According to [PEP 8], there should be one space before and after bitwise and
+/// shift operators (<<, >>, &, |, ^).
+///
+/// ## Example
+/// ```python
+/// x = 128<<1
+/// ```
+///
+/// Use instead:
+/// ```python
+/// x = 128 << 1
+/// ```
+///
+/// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves
 // E227
 #[violation]
 pub struct MissingWhitespaceAroundBitwiseOrShiftOperator;
@@ -38,6 +94,24 @@ impl Violation for MissingWhitespaceAroundBitwiseOrShiftOperator {
     }
 }
 
+/// ## What it does
+/// Checks for missing whitespace around the modulo operator.
+///
+/// ## Why is this bad?
+/// According to [PEP 8], the modulo operator (%) should have whitespace on
+/// either side of it.
+///
+/// ## Example
+/// ```python
+/// remainder = 10%2
+/// ```
+///
+/// Use instead:
+/// ```python
+/// remainder = 10 % 2
+/// ```
+///
+/// [PEP 8]: https://peps.python.org/pep-0008/#other-recommendations
 // E228
 #[violation]
 pub struct MissingWhitespaceAroundModuloOperator;
diff --git a/scripts/check_docs_formatted.py b/scripts/check_docs_formatted.py
index e6ad2cbbc4..686ff1f5bf 100755
--- a/scripts/check_docs_formatted.py
+++ b/scripts/check_docs_formatted.py
@@ -37,6 +37,10 @@ KNOWN_FORMATTING_VIOLATIONS = [
     "indentation-with-invalid-multiple",
     "line-too-long",
     "missing-trailing-comma",
+    "missing-whitespace-around-arithmetic-operator",
+    "missing-whitespace-around-bitwise-or-shift-operator",
+    "missing-whitespace-around-modulo-operator",
+    "missing-whitespace-around-operator",
     "multi-line-implicit-string-concatenation",
     "multiple-leading-hashes-for-block-comment",
     "multiple-spaces-after-keyword",