Skip to content

Commit 7f68c2e

Browse files
committed
Revert "docs: manually fix some messed up refactors"
This reverts commit aabab9a.
1 parent aabab9a commit 7f68c2e

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/topics/02_dependency-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ By choosing {uv}`uv<>`, the template makes a deliberate, opinionated choice to f
139139
## Interactions with Other Topics
140140

141141
- **pyproject.toml (01):** {uv}`uv<>` is the primary consumer and editor of the `[project]`, `[build-system]`, and `[project.optional-dependencies]` tables in `pyproject.toml`, acting as the interpreter for packaging standards. Its own configuration goes in `[tool.uv]`.
142-
- **Packaging Build (09):** {uv}`uv<>` acts as a PEP 517 build frontend (`uv build`), calling the appropriate backend ({setuptools}`setuptools<>` or {maturin}`maturin<>`) configured in `pyproject.toml`.
142+
- **Packaging Build (09):** {uv}`uv<>` acts as a PEP 517 build frontend (`uv build`), calling the appropriate backend ({setuptools-documentation}`setuptools<>` or {maturin-documentation}`maturin<>`) configured in `pyproject.toml`.
143143
- **Packaging Publish (10):** {uv}`uv<>` provides a command to publish packages (`uv publish`) as an alternative to using {twine}`twine<>` directly. The Task Automation layer (12) might call `uv publish`.
144144
- **Task Automation (12):** {nox}`Nox<>` will orchestrate workflows by calling {uv}`uv<>` commands (e.g., `uv run ruff check`, `uv run pytest`, `uv build`, `uv publish`). {uv}`uv<>` is also configured as the backend for Nox's virtual environments (`nox.options.default_venv_backend = "uv"`), ensuring all session environments are created and managed with {uv}`uv<>`'s performance.
145145
- **Container Build (11):** {uv}`uv<>` is the recommended tool for installing dependencies _inside_ the `Dockerfile` (`RUN uv sync`).

docs/topics/04_code-linting.md

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

6464
- **Conclusion:** The most comprehensive static analyzer for Python. Offers great depth but requires significant configuration effort and suffers from performance issues that impact its usability in fast, iterative development stages. Best suited for thorough analysis in slower workflows like CI.
6565

66-
### Option 3: {prospector}`Prospector<>` (Lint Tool Composer)
66+
### Option 3: :flake8-documentation - often evaluated alongside linters:`Prospector`
6767

68-
- **Description:** A meta-tool that runs multiple other Python analysis tools (like {flake8}`Flake8<>`, {pylint}`Pylint<>`, {bandit}`Bandit<>`, {mypy}`Mypy<>` (alternative to Pyright)) and aggregates their output into a unified report.
68+
- **Description:** A meta-tool that runs multiple other Python analysis tools (like {flake8}`Flake8<>`, {pylint}`Pylint<>`, {bandit}`Bandit<>`, :pyright-documentation - alternative to Pyright:`Mypy`) and aggregates their output into a unified report.
6969
- **Evaluation:**
7070

7171
- **Static Analysis Capabilities:** Varies (Delegated). Its capabilities are the sum of the tools it wraps.

0 commit comments

Comments
 (0)