Skip to content

Commit eed89c6

Browse files
committed
docs: add several incorrect url fixes
1 parent 8c3c002 commit eed89c6

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/topics/04_code-linting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ We evaluated the leading options for Python code linting and static analysis:
2929

3030
### Option 1: [:term:`Flake8`](flake8-documentation)
3131

32-
- **Description:** A popular wrapper that bundles multiple checks: [:term:`PyFlakes`](pip-tools-documentation) (finds errors like unused variables, undefined names), [:term:`pycodestyle`](flake8-documentation) (checks against PEP 8 style guide), and [:term:`mccabe`](flake8-documentation) (checks code complexity). Highly extensible via plugins.
32+
- **Description:** A popular wrapper that bundles multiple checks: [:term:`PyFlakes`](pyflakes-documentation) (finds errors like unused variables, undefined names), [:term:`pycodestyle`](pycodestyle-documentation) (checks against PEP 8 style guide), and [:term:`mccabe`](mccabe-documentation) (checks code complexity). Highly extensible via plugins.
3333
- **Evaluation:**
3434

3535
- **Static Analysis Capabilities:** Good basic coverage via bundled tools. Very high potential via a rich ecosystem of plugins (e.g., `flake8-bugbear` for common pitfalls, `flake8-annotations` for type hint checks, etc.) covering a wide range of issues.
@@ -113,7 +113,7 @@ We evaluated the leading options for Python code linting and static analysis:
113113
6. **Seamless Integration:** [:term:`Ruff`](ruff-documentation)'s speed and standard CLI integrate **excellently** into automated workflows, making it uniquely suitable for fast [:term:`pre-commit`](pre-commit-documentation) hooks (Area 18), rapid Task Automation runs ([:term:`Nox`](nox-documentation) - Area 12), and efficient CI checks (Area 13) (addressing **Integration**).
114114
7. **Unified with Formatting:** Choosing [:term:`Ruff`](ruff-documentation) for both formatting (03) and linting (04) provides a powerful, unified solution for code style and quality from a single tool with a single configuration file.
115115

116-
While [:term:`Pylint`](pylint-documentation) offers potentially deeper analysis in some niche areas and [:term:`Flake8`](flake8-documentation) has a mature plugin ecosystem, [:term:`Ruff`](ruff-documentation)'s overwhelming performance advantage and consolidation of common rules provide a better balance for a general-purpose, high-quality template prioritizing automated workflow efficiency. [:term:`Prospector`](flake8-documentation), as a meta-tool, does not offer performance benefits and adds complexity.
116+
While [:term:`Pylint`](pylint-documentation) offers potentially deeper analysis in some niche areas and [:term:`Flake8`](flake8-documentation) has a mature plugin ecosystem, [:term:`Ruff`](ruff-documentation)'s overwhelming performance advantage and consolidation of common rules provide a better balance for a general-purpose, high-quality template prioritizing automated workflow efficiency. [:term:`Prospector`](prospector-documentation), as a meta-tool, does not offer performance benefits and adds complexity.
117117

118118
We also include **[:term:`pydocstyle`](pydocstyle-documentation)** conceptually here (or within Topic 07 justification) as it specifically checks **PEP 257** compliance for docstrings, which is crucial for documentation generation quality. Its rules are included in [:term:`Ruff`](ruff-documentation)'s linting set ('D' codes), so running [:term:`Ruff`](ruff-documentation) with 'D' rules enabled covers this. We list it separately to highlight the specific focus on docstrings, noting [:term:`Ruff`](ruff-documentation) handles these checks.
119119

0 commit comments

Comments
 (0)