diff --git a/docs/developer_guide/code_guidelines/source_code.md b/docs/developer_guide/code_guidelines/source_code.md index d3feb231..a790629a 100644 --- a/docs/developer_guide/code_guidelines/source_code.md +++ b/docs/developer_guide/code_guidelines/source_code.md @@ -20,7 +20,7 @@ just format just check ``` -If there's absolutely no alternative, use `# pyright: ignore[errorCode]` or `#NOQA: errorCode` to ignore typing or linting errors. +If there's absolutely no alternative, use `# ty: ignore[error-code]` or `#NOQA: error-code` to ignore typing or linting errors. ## Docstrings diff --git a/docs/developer_guide/index.md b/docs/developer_guide/index.md index 03ca5a87..f9c88966 100644 --- a/docs/developer_guide/index.md +++ b/docs/developer_guide/index.md @@ -52,8 +52,8 @@ That's it! You're now ready to start developing RenderCV. ### Development - `just sync`: Sync all dependencies (including extras and dev groups) -- `just format`: Format code with black and ruff -- `just check`: Run all checks (ruff, pyright, pre-commit) +- `just format`: Format code with `black` and `ruff` +- `just check`: Run all checks (`ruff`, `ty`, `pre-commit`) - `just lock`: Update `uv.lock` file ### Testing diff --git a/docs/developer_guide/project_management.md b/docs/developer_guide/project_management.md index 1163ecd9..ca065b9e 100644 --- a/docs/developer_guide/project_management.md +++ b/docs/developer_guide/project_management.md @@ -81,7 +81,7 @@ This file defines: - Dependencies (what packages RenderCV needs) - Entry points (makes `rendercv` a command) - Build configuration (how to package RenderCV) -- Tool settings (`ruff`, `pyright`, `pytest`, etc.) +- Tool settings (`ruff`, `ty`, `pytest`, etc.) Open the file to see the full configuration with detailed comments. @@ -119,7 +119,7 @@ These scripts are called by `just` commands (`just update-schema`, `just update- Configuration file for [`pre-commit`](https://pre-commit.com/), a tool that runs code quality checks. -**Why do we need it?** Pre-commit's value is **fast CI/CD**. [pre-commit.ci](https://pre-commit.ci/) (free for open-source projects) automatically checks if the source code has any `ruff` or `pyright` errors on every push and pull request. Forgot to format your code? The workflow fails, making it immediately obvious. +**Why do we need it?** Pre-commit's value is **fast CI/CD**. [pre-commit.ci](https://pre-commit.ci/) (free for open-source projects) automatically checks if the source code has any `ruff` or `ty` errors on every push and pull request. Forgot to format your code? The workflow fails, making it immediately obvious. ### [`uv.lock`](https://github.com/rendercv/rendercv/blob/main/uv.lock)