Skip to content

Suggest using uv in template README

26d800b
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

Recommend uv for virtual environment management #617

Suggest using uv in template README
26d800b
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Feb 23, 2026 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (2)

docs/pages/virtual.md|16 col 104| [proselint.Very] Remove 'very'.
docs/pages/virtual.md|16 col 104| [write-good.Weasel] 'very' is a weasel word!

Filtered Findings (128)

docs/pages/ci.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (12.13) below 9.
docs/pages/ci.md|1 col 1| [Readability.LIX] Try to keep the LIX score (36.97) below 35.
docs/pages/ci.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (49.54) above 70.
docs/pages/ci.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (8.60) below 8.
docs/pages/ci.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (9.08) below 8.
docs/pages/ci.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (10.11) below 10.
docs/pages/ci.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (11.77) below 10.
docs/pages/ci.md|30 col 94| [proselint.Very] Remove 'Very'.
docs/pages/ci.md|30 col 94| [write-good.Weasel] 'Very' is a weasel word!
docs/pages/community.md|1 col 1| [Readability.LIX] Try to keep the LIX score (42.09) below 35.
docs/pages/community.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (52.09) above 70.
docs/pages/community.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (9.13) below 8.
docs/pages/community.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (9.60) below 8.
docs/pages/community.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (12.01) below 10.
docs/pages/community.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (12.16) below 10.
docs/pages/community.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (11.25) below 9.
docs/pages/community.md|8 col 1| [write-good.ThereIs] Don't start a sentence with 'There are'.
docs/index.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (9.68) below 9.
docs/index.md|1 col 1| [Readability.LIX] Try to keep the LIX score (35.99) below 35.
docs/index.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (58.36) above 70.
docs/index.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (8.38) below 8.
docs/index.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (10.88) below 10.
README.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (10.31) below 9.
README.md|1 col 1| [Readability.LIX] Try to keep the LIX score (43.09) below 35.
README.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (55.44) above 70.
README.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (8.53) below 8.
README.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (9.23) below 8.
README.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (10.39) below 10.
README.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (11.21) below 10.
CONTRIBUTING.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (9.42) below 9.
CONTRIBUTING.md|1 col 1| [Readability.LIX] Try to keep the LIX score (37.39) below 35.
CONTRIBUTING.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (62.22) above 70.
CONTRIBUTING.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (10.44) below 10.
CONTRIBUTING.md|41 col 4| [write-good.Weasel] 'quite' is a weasel word!
docs/pages/docs.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (48.02) above 70.
docs/pages/docs.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (9.34) below 8.
docs/pages/docs.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (10.33) below 8.
docs/pages/docs.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (13.17) below 10.
docs/pages/docs.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (12.90) below 10.
docs/pages/docs.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (11.20) below 9.
docs/pages/docs.md|1 col 1| [Readability.LIX] Try to keep the LIX score (39.52) below 35.
docs/pages/docs.md|8 col 49| [proselint.Very] Remove 'very'.
docs/pages/docs.md|8 col 49| [write-good.Weasel] 'very' is a weasel word!
docs/pages/docs.md|31 col 116| [proselint.Very] Remove 'very'.
docs/pages/docs.md|31 col 116| [write-good.Weasel] 'very' is a weasel word!
docs/pages/libraries/index.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (52.45) above 70.
docs/pages/libraries/index.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (11.48) below 8.
docs/pages/libraries/index.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (11.46) below 8.
docs/pages/libraries/index.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (12.48) below 10.
docs/pages/libraries/index.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (12.34) below 10.
docs/pages/libraries/index.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (10.09) below 9.
docs/pages/libraries/index.md|1 col 1| [Readability.LIX] Try to keep the LIX score (45.62) below 35.
docs/pages/libraries/jupyter-notebooks.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (13.48) below 9.
docs/pages/libraries/jupyter-notebooks.md|1 col 1| [Readability.LIX] Try to keep the LIX score (54.38) below 35.
docs/pages/libraries/jupyter-notebooks.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (32.28) above 70.
docs/pages/libraries/jupyter-notebooks.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (12.63) below 8.
docs/pages/libraries/jupyter-notebooks.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (13.39) below 8.
docs/pages/libraries/jupyter-notebooks.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (17.47) below 10.
docs/pages/libraries/jupyter-notebooks.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (16.11) below 10.
docs/pages/libraries/jupyter-notebooks.md|29 col 1| [write-good.ThereIs] Don't start a sentence with 'There is'.
docs/pages/linting.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (61.33) above 70.
docs/pages/linting.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (12.00) below 10.
docs/pages/linting.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (11.21) below 10.
docs/pages/libraries/parallel-async.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (23.06) above 70.
docs/pages/libraries/parallel-async.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (17.42) below 8.
docs/pages/libraries/parallel-async.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (16.70) below 8.
docs/pages/libraries/parallel-async.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (18.48) below 10.
docs/pages/libraries/parallel-async.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (17.81) below 10.
docs/pages/libraries/parallel-async.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (14.87) below 9.
docs/pages/libraries/parallel-async.md|1 col 1| [Readability.LIX] Try to keep the LIX score (58.14) below 35.
docs/pages/libraries/parallel-async.md|29 col 119| [proselint.Typography] Consider using the '…' symbol instead of '...'.
docs/pages/templates.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (11.27) below 9.
docs/pages/templates.md|1 col 1| [Readability.LIX] Try to keep the LIX score (49.92) below 35.
docs/pages/templates.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (49.26) above 70.
docs/pages/templates.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (10.94) below 8.
docs/pages/templates.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (11.07) below 8.
docs/pages/templates.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (11.48) below 10.
docs/pages/templates.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (11.77) below 10.
docs/pages/packaging.md|1 col 1| [Readability.LIX] Try to keep the LIX score (40.69) below 35.
docs/pages/packaging.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (62.42) above 70.
docs/pages/packaging.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (8.41) below 8.
docs/pages/packaging.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (10.83) below 10.
docs/pages/packaging.md|10 col 1| [write-good.Weasel] 'several' is a weasel word!
tests/data/test_package_generation/docs/api.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (14.69) below 8.
tests/data/test_package_generation/docs/api.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (20.80) below 10.
tests/data/test_package_generation/docs/api.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (16.44) below 9.
tests/data/test_package_generation/docs/api.md|1 col 1| [Readability.LIX] Try to keep the LIX score (52.00) below 35.
tests/data/test_package_generation/docs/api.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (-6.69) above 70.
tests/data/test_package_generation/docs/api.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (17.25) below 8.
tests/data/test_package_generation/docs/index.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (11.34) below 9.
tests/data/test_package_generation/docs/index.md|1 col 1| [Readability.LIX] Try to keep the LIX score (54.00) below 35.
tests/data/test_package_generation/docs/index.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (44.15) above 70.
tests/data/test_package_generation/docs/index.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (8.24) below 8.
tests/data/test_package_generation/docs/index.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (8.09) below 8.
{{cookiecutter.project_slug}}/docs/api.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (6.39) above 70.
{{cookiecutter.project_slug}}/docs/api.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (16.18) below 8.
{{cookiecutter.project_slug}}/docs/api.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (13.11) below 8.
{{cookiecutter.project_slug}}/docs/api.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (14.53) below 10.
{{cookiecutter.project_slug}}/docs/api.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (19.41) below 9.
{{cookiecutter.project_slug}}/docs/api.md|1 col 1| [Readability.LIX] Try to keep the LIX score (69.67) below 35.
{{cookiecutter.project_slug}}/docs/index.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (11.34) below 9.
{{cookiecutter.project_slug}}/docs/index.md|1 col 1| [Readability.LIX] Try to keep the LIX score (54.00) below 35.
{{cookiecutter.project_slug}}/docs/index.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (44.15) above 70.
{{cookiecutter.project_slug}}/docs/index.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (8.24) below 8.
{{cookiecutter.project_slug}}/docs/index.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (8.09) below 8.
tests/data/test_package_generation/README.md|1 col 1| [Readability.LIX] Try to keep the LIX score (43.37) below 35.
tests/data/test_package_generation/README.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (38.41) above 70.
tests/data/test_package_generation/README.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (9.93) below 8.
tests/data/test_package_generation/README.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (11.63) below 10.
tests/data/test_package_generation/README.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (10.95) below 10.
tests/data/test_package_generation/README.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (11.78) below 9.
{{cookiecutter.project_slug}}/README.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (14.37) below 9.
{{cookiecutter.project_slug}}/README.md|1 col 1| [Readability.LIX] Try to keep the LIX score (46.59) below 35.
{{cookiecutter.project_slug}}/README.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (28.13) above 70.
{{cookiecutter.project_slug}}/README.md|1 col 1| [Readability.AutomatedReadability] Try to keep the Automated Readability Index (9.88) below 8.
{{cookiecutter.project_slug}}/README.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (11.58) below 8.
{{cookiecutter.project_slug}}/README.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (14.21) below 10.
{{cookiecutter.project_slug}}/README.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (12.23) below 10.
docs/pages/tutorial.md|1 col 1| [Readability.FleschReadingEase] Try to keep the Flesch reading ease score (58.10) above 70.
docs/pages/tutorial.md|1 col 1| [Readability.FleschKincaid] Try to keep the Flesch–Kincaid grade level (8.70) below 8.
docs/pages/tutorial.md|1 col 1| [Readability.GunningFog] Try to keep the Gunning-Fog index (10.65) below 10.
docs/pages/tutorial.md|1 col 1| [Readability.SMOG] Try to keep the SMOG grade (11.20) below 10.
docs/pages/tutorial.md|1 col 1| [Readability.ColemanLiau] Try to keep the Coleman–Liau Index grade (9.82) below 9.
docs/pages/tutorial.md|1 col 1| [Readability.LIX] Try to keep the LIX score (39.17) below 35.
docs/pages/tutorial.md|42 col 94| [write-good.Weasel] 'usually' is a weasel word!
docs/pages/tutorial.md|253 col 1| [write-good.ThereIs] Don't start a sentence with 'There are'.
docs/pages/tutorial.md|255 col 12| [write-good.Weasel] 'extremely' is a weasel word!
docs/pages/tutorial.md|403 col 1| [write-good.ThereIs] Don't start a sentence with 'There is'.

Annotations

Check failure on line 16 in docs/pages/virtual.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/virtual.md#L16

[proselint.Very] Remove 'very'.
Raw output
{"message": "[proselint.Very] Remove 'very'.", "location": {"path": "docs/pages/virtual.md", "range": {"start": {"line": 16, "column": 104}}}, "severity": "ERROR"}

Check warning on line 16 in docs/pages/virtual.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/virtual.md#L16

[write-good.Weasel] 'very' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'very' is a weasel word!", "location": {"path": "docs/pages/virtual.md", "range": {"start": {"line": 16, "column": 104}}}, "severity": "WARNING"}