Skip to content

Commit 875bb33

Browse files
committed
docs: update main repo documentations files to reference basedpyright instead of pyright
1 parent 52b7a8a commit 875bb33

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ This is a really brief/condensed idea of what is planned for this template, and
8585
<details>
8686
<summary>Click to expand</summary>
8787

88-
- [x] Swap to UV, Ruff, and Pyright (maybe ty later, but at the moment of writing this isn't ready yet)
88+
- [x] Swap to UV, Ruff, and Basedpyright (maybe ty later, but at the moment of writing this wasn't ready yet)
8989
- [x] Add cruft and commitizen
9090
- [x] Centralize CI/CD through noxfile using uv cache to maintain speed
9191
- [x] Add CI/CD for GitHub, Gitlab, and Bitbucket (Only GitHub guaranteed to work, but others should be close enough)

{{cookiecutter.project_name}}/CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ This project follows these standards:
121121

122122
- **Code formatting:** [Ruff][ruff-documentation] (automatically applied by pre-commit)
123123
- **Linting:** Ruff with comprehensive rule set
124-
- **Type checking:** [Pyright][pyright-documentation]
124+
- **Type checking:** [Basedpyright][basedpyright-documentation]
125125
- **Security:** [Bandit][bandit-documentation] for security linting
126126
- **Commit messages:** [Conventional Commits][conventional-commits] format preferred
127127
- **Testing:** [pytest][pytest-documentation] with good coverage
@@ -168,7 +168,7 @@ Common Nox sessions for development:
168168
# Code quality
169169
uvx nox -s format-python # Format with Ruff
170170
uvx nox -s lint-python # Lint with Ruff
171-
uvx nox -s typecheck # Type check with Pyright
171+
uvx nox -s typecheck # Type check with Basedpyright
172172
uvx nox -s security-python # Security checks
173173

174174
# Testing
@@ -206,6 +206,7 @@ _This project was generated from the [cookiecutter-robust-python][cookiecutter-r
206206
{% if cookiecutter.repository_provider == 'github' %}[discussions]: https://{{ cookiecutter.repository_host }}/{{ cookiecutter.repository_path }}/discussions{% endif %}
207207
[uv-documentation]: https://docs.astral.sh/uv/
208208
[ruff-documentation]: https://docs.astral.sh/ruff/
209+
[basedpyright-documentation]: https://github.com/detachhead/basedpyright
209210
[pyright-documentation]: https://github.com/microsoft/pyright
210211
[bandit-documentation]: https://bandit.readthedocs.io/
211212
[conventional-commits]: https://www.conventionalcommits.org/

0 commit comments

Comments
 (0)