Self documenting code in Python

python
Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```

Install this rule for wispbit

Add this rule to wispbit and it will run when you open a pull request

Install this rule for Coderabbit

Copy the configuration below and add it to your repository as .coderabbit.yml in your project root.

reviews:
  path_instructions:
    - path: "*.py"
      instructions: |
                
        Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
        
        Bad:
        
        ```python
        # Join the test directory with the base directory
        test_dir = os.path.join(BASE_DIR, test_case.identifier)
        ```
        
        Good:
        
        ```python
        test_dir = os.path.join(BASE_DIR, test_case.identifier)
        ```

Install this rule for Greptile

Greptile rules can be added through the web interface. Please see this documentation for details on how to add custom rules and context.

Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```
Good:
```python
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```

File Path Patterns:

*.py

Install this rule for GitHub Copilot

Copilot instructions can be added through the interface. See the documentation for details on how to create coding guidelines.

Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```
Good:
```python
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```

File Path Patterns:

*.py

Install this rule for Graphite Diamond

Diamond custom rules can be added through the interface. See the documentation for details on how to create custom rules.

Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```
Good:
```python
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```

File Path Patterns:

*.py

Use with Cline

Copy the rule below and ask Cline to review your code using this rule

Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```
Good:
```python
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```

Use with OpenAI Codex

Copy the rule below and ask OpenAI Codex to review your code using this rule

Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```
Good:
```python
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```

Use with Cursor

Copy the rule below and ask Cursor to review your code using this rule

Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```
Good:
```python
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```

Use with Claude Code

Copy the rule below and ask Claude Code to review your code using this rule

Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```
Good:
```python
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```

Install this rule for Windsurf

To set up rules for Windsurf Reviews, please see this documentation 

Avoid unnecessary explanatory comments for code that is self-documenting. Comments should only be used when they add context that the code itself cannot convey.
Bad:
```python
# Join the test directory with the base directory
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```
Good:
```python
test_dir = os.path.join(BASE_DIR, test_case.identifier)
```