Skip to content

Commit 1efd90c

Browse files
committed
Revert "docs: replace faulty links for uv"
This reverts commit d75565b.
1 parent 9bebd5b commit 1efd90c

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/topics/03_code-formatting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ We evaluated the leading options for automated code formatting:
3333
- **Opinionatedness & Configuration:** Very High. Famously requires minimal configuration (`--line-length` is a common option). Aligns with the "Opinionated is better than impartial" philosophy.
3434
- **Performance:** Good. Reasonably fast for typical file sizes and project sizes. Noticeably slower than Rust-based alternatives like :ruff-documentation:`Ruff` on larger codebases or when run very frequently.
3535
- **OS Interoperability:** Excellent. Pure Python package, works reliably on all major operating systems.
36-
- **Integration:** Excellent. Long-standing standard, strong integration with :pre-commit-documentation:`pre-commit`, :nox-documentation:`Nox`/:uv-documentation:`uv`, CI platforms, and almost all editors/IDEs.
36+
- **Integration:** Excellent. Long-standing standard, strong integration with :pre-commit-documentation:`pre-commit`, :nox-documentation:`Nox`/[:term:`uv` run](uv-documentation), CI platforms, and almost all editors/IDEs.
3737
- **Tool Count:** Moderate. Requires using two separate tools (`black`, `isort`) for the complete formatting task (code style + import sorting). Adds a small layer of management (dependencies, running both).
3838
- **Maturity & Stability:** Very High. Mature, stable, widely used standard.
3939
- **Community & Documentation:** Very High. Large, active community, extensive documentation.
@@ -79,7 +79,7 @@ We evaluated the leading options for automated code formatting:
7979
- **Opinionatedness & Configuration:** Very High. Highly opinionated with minimal configuration, inheriting philosophy from :black-documentation:`Black`. Configuration is shared with the linter in `pyproject.toml` or `.ruff.toml`.
8080
- **Performance:** Excellent. **Orders of magnitude faster** than all Python-based formatters (:black-documentation:`Black`, :isort-documentation:`isort`, :autopep8-documentation:`autopep8`, :yapf-documentation:`yapf`). This is a major practical advantage, especially for pre-commit hooks and large projects.
8181
- **OS Interoperability:** Excellent. Rust binary, works natively and reliably across all major operating systems.
82-
- **Integration:** Excellent and Growing Rapidly. Native support in :pre-commit-documentation:`pre-commit`, easily callable via CLI for :nox-documentation:`Nox`/:uv-documentation:`uv`, integrates into CI, rapidly gaining editor/IDE support due to its speed and dual formatting/linting capabilities.
82+
- **Integration:** Excellent and Growing Rapidly. Native support in :pre-commit-documentation:`pre-commit`, easily callable via CLI for :nox-documentation:`Nox`/[:term:`uv` run](uv-documentation), integrates into CI, rapidly gaining editor/IDE support due to its speed and dual formatting/linting capabilities.
8383
- **Tool Count:** Excellent. **Consolidates code formatting AND import sorting** into a single tool and command (`ruff format`).
8484
- **Maturity & Stability:** High (Formatter is newer than Linter, but built on stable core). :ruff-documentation:`Ruff` as a project is very mature. The formatter feature itself is newer but built on the same highly performant core and rapidly stabilizing, considered production-ready by its authors.
8585
- **Community & Documentation:** High (Exploding). Very active development, massive and rapidly growing user base, excellent and extensive documentation.

docs/topics/04_code-linting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ We evaluated the leading options for Python code linting and static analysis:
3838
- **Configurable:** High. Configurable via `.flake8`, `setup.cfg`, or `pyproject.toml` (`[flake8]`). Default checks are standard, but many plugins require explicit configuration.
3939
- **Performance:** Moderate. As a Python tool wrapping other Python tools, performance is acceptable for many projects but noticeably slower than Rust-based alternatives, potentially impacting editor feedback speed or pre-commit hook viability on large codebases.
4040
- **OS Interoperability:** Excellent. Pure Python package, works reliably across Linux, macOS, and Windows.
41-
- **Integration:** Excellent. A long-standing standard, deep integration across editors/IDEs, :pre-commit-documentation:`pre-commit` (official hook), :nox-documentation:`Nox`/:uv-documentation:`uv`, CI/CD platforms.
41+
- **Integration:** Excellent. A long-standing standard, deep integration across editors/IDEs, :pre-commit-documentation:`pre-commit` (official hook), :nox-documentation:`Nox`/[:term:`uv` run](uv-documentation), CI/CD platforms.
4242
- **Tool Count:** Moderate. It's a wrapper, so requires installing :flake8-documentation:`flake8` itself plus desired plugins. Simpler than installing PyFlakes, pycodestyle, etc. separately. Often used alongside a formatter.
4343
- **Maturity & Stability:** Very High. Mature, stable, widely adopted for many years.
4444
- **Community & Documentation:** Very High. Large, active community, extensive documentation for both base :flake8-documentation:`flake8` and its plugins.
@@ -91,7 +91,7 @@ We evaluated the leading options for Python code linting and static analysis:
9191
- **Configurable:** High. Configurable via `.ruff.toml` or `pyproject.toml`. Powerful and flexible rule selection. Default set includes core checks, adding more rules (like Pylint conventions) is explicit.
9292
- **Performance:** Excellent. **Orders of magnitude faster** than Python-based linters. Transformative for developer workflow feedback loops (real-time checks in editors, pre-commit speed) and CI times.
9393
- **OS Interoperability:** Excellent. Rust binary, works natively and reliably across all major operating systems.
94-
- **Integration:** Excellent. Rapidly gaining ecosystem integration. Native :pre-commit-documentation:`pre-commit` hook (highly recommended due to speed). Easily callable via CLI for :nox-documentation:`Nox`/:uv-documentation:`uv`, integrates into CI, strong and increasing editor/IDE support.
94+
- **Integration:** Excellent. Rapidly gaining ecosystem integration. Native :pre-commit-documentation:`pre-commit` hook (highly recommended due to speed). Easily callable via CLI for :nox-documentation:`Nox`/[:term:`uv` run](uv-documentation), integrates into CI, strong and increasing editor/IDE support.
9595
- **Tool Count:** Excellent. **Consolidates the functionality of multiple separate linters** into a single binary and configuration file. Also includes formatting.
9696
- **Maturity & Stability:** Very High (Linter). :ruff-documentation:`Ruff` as a linter is mature, stable, and very widely adopted. The project has a massive and active community.
9797
- **Community & Documentation:** Very High (Exploding). Very active development, massive and rapidly growing user base, excellent and extensive documentation.

docs/topics/08_security-checks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ We evaluated the primary tools for dependency and code-level security checks in
9393
- **Reporting:** Excellent. Uses :ruff-documentation:`Ruff`'s standard, clear reporting format.
9494
- **Performance:** Excellent. As a Rust binary, running these checks is very fast (similar to linting performance).
9595
- **OS Interoperability:** Excellent. Rust binary, works across OSs.
96-
- **Integration:** Excellent. Seamlessly integrated into :ruff-documentation:`Ruff`'s check command, leveraging its integrations (:pre-commit-documentation:`pre-commit`, :nox-documentation:`Nox`/:uv-documentation:`uv`, CI). Speed makes it ideal for fast checks.
96+
- **Integration:** Excellent. Seamlessly integrated into :ruff-documentation:`Ruff`'s check command, leveraging its integrations (:pre-commit-documentation:`pre-commit`, :nox-documentation:`Nox`/[:term:`uv` run](uv-documentation), CI). Speed makes it ideal for fast checks.
9797
- **Maturity & Stability:** High (:ruff-documentation:`Ruff`), Low (Security Rules). The :ruff-documentation:`Ruff` platform is mature. The _security rule set_ is still very new and under active development, not comprehensive enough for full standalone security code analysis.
9898
- **Community & Documentation:** High (:ruff-documentation:`Ruff`), Moderate (Security Rules). Benefits from the large :ruff-documentation:`Ruff` community, but specific documentation and community experience with _just_ the security rules are still building.
9999

0 commit comments

Comments
 (0)