Skip to content

Add --no-write-to-file flag for read-only doccmd commands #2717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 8, 2025
Merged

Add --no-write-to-file flag for read-only doccmd commands #2717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e983194
Add --no-write-to-file flag for read-only doccmd commands
adamtheturtle Nov 8, 2025
3ba7058
Bump doccmd to 2025.11.8.1 and sybil-extras to 2025.11.8
adamtheturtle Nov 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ repos:

- id: shellcheck-docs
name: shellcheck-docs
entry: uv run --extra=dev doccmd --language=shell --language=console --command="shellcheck
--shell=bash"
entry: uv run --extra=dev doccmd --no-write-to-file --language=shell --language=console
--command="shellcheck --shell=bash"
language: python
types_or: [markdown, rst]
additional_dependencies: [uv==0.9.5]
Expand Down Expand Up @@ -153,7 +153,7 @@ repos:
- id: mypy-docs
name: mypy-docs
stages: [pre-push]
entry: uv run --extra=dev doccmd --language=python --command="mypy"
entry: uv run --extra=dev doccmd --no-write-to-file --language=python --command="mypy"
language: python
types_or: [markdown, rst]
additional_dependencies: [uv==0.9.5]
Expand All @@ -178,7 +178,7 @@ repos:
- id: pyright-docs
name: pyright-docs
stages: [pre-push]
entry: uv run --extra=dev doccmd --language=python --command="pyright"
entry: uv run --extra=dev doccmd --no-write-to-file --language=python --command="pyright"
language: python
types_or: [markdown, rst]
additional_dependencies: [uv==0.9.5]
Expand All @@ -194,7 +194,7 @@ repos:

- id: vulture-docs
name: vulture docs
entry: uv run --extra=dev doccmd --language=python --command="vulture"
entry: uv run --extra=dev doccmd --no-write-to-file --language=python --command="vulture"
language: python
types_or: [markdown, rst]
additional_dependencies: [uv==0.9.5]
Expand Down Expand Up @@ -227,7 +227,7 @@ repos:

- id: pylint-docs
name: pylint-docs
entry: uv run --extra=dev doccmd --language=python --command="pylint"
entry: uv run --extra=dev doccmd --no-write-to-file --language=python --command="pylint"
language: python
stages: [manual]
types_or: [markdown, rst]
Expand Down Expand Up @@ -284,7 +284,7 @@ repos:

- id: interrogate-docs
name: interrogate docs
entry: uv run --extra=dev doccmd --language=python --command="interrogate"
entry: uv run --extra=dev doccmd --no-write-to-file --language=python --command="interrogate"
language: python
types_or: [markdown, rst]
additional_dependencies: [uv==0.9.5]
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ optional-dependencies.dev = [
"check-manifest==0.51",
"deptry==0.23.1",
"doc8==2.0.0",
"doccmd==2025.10.27",
"doccmd==2025.11.8",
"docformatter==1.7.7",
"freezegun==1.5.5",
"furo==2025.9.25",
Expand Down