Skip to content

Add Vale for content linting to the repo #541

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
paddyroddy merged 34 commits into from
Jun 6, 2025

Genuine bug: "the the"

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

Add Vale for content linting to the repo #541

Genuine bug: "the the"
f8aad48
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Jun 6, 2025 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (18)

docs/pages/ci.md|30 col 94| [write-good.Weasel] 'Very' is a weasel word!
docs/pages/ci.md|30 col 94| [proselint.Very] Remove 'Very'.
CONTRIBUTING.md|41 col 4| [write-good.Weasel] 'quite' is a weasel word!
README.md|18 col 5| [proselint.Annotations] 'NOTE' left in text.
docs/pages/community.md|8 col 1| [write-good.ThereIs] Don't start a sentence with 'There are'.
CODE_OF_CONDUCT.md|64 col 14| [write-good.Weasel] 'fairly' is a weasel word!
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| [write-good.Weasel] 'very' is a weasel word!
docs/pages/docs.md|31 col 116| [proselint.Very] Remove 'very'.
docs/pages/libraries/jupyter-notebooks.md|29 col 1| [write-good.ThereIs] Don't start a sentence with 'There is'.
docs/pages/libraries/parallel-async.md|29 col 119| [proselint.Typography] Consider using the '…' symbol instead of '...'.
docs/pages/virtual.md|16 col 104| [write-good.Weasel] 'very' is a weasel word!
docs/pages/virtual.md|16 col 104| [proselint.Very] Remove 'very'.
docs/pages/packaging.md|10 col 1| [write-good.Weasel] 'several' is a weasel word!
tutorial.md|10 col 34| [proselint.Typography] Consider using the '…' symbol instead of '...'.
tutorial.md|201 col 1| [write-good.ThereIs] Don't start a sentence with 'There are'.
tutorial.md|201 col 269| [write-good.Weasel] 'extremely' is a weasel word!

Filtered Findings (0)

Annotations

Check warning on line 30 in docs/pages/ci.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/ci.md#L30 

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

Check failure on line 30 in docs/pages/ci.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/ci.md#L30 

[proselint.Very] Remove 'Very'.
Raw output 
{"message": "[proselint.Very] Remove 'Very'.", "location": {"path": "docs/pages/ci.md", "range": {"start": {"line": 30, "column": 94}}}, "severity": "ERROR"}

Check warning on line 41 in CONTRIBUTING.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] CONTRIBUTING.md#L41 

[write-good.Weasel] 'quite' is a weasel word!
Raw output 
{"message": "[write-good.Weasel] 'quite' is a weasel word!", "location": {"path": "CONTRIBUTING.md", "range": {"start": {"line": 41, "column": 4}}}, "severity": "WARNING"}

Check failure on line 18 in README.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] README.md#L18 

[proselint.Annotations] 'NOTE' left in text.
Raw output 
{"message": "[proselint.Annotations] 'NOTE' left in text.", "location": {"path": "README.md", "range": {"start": {"line": 18, "column": 5}}}, "severity": "ERROR"}

Check failure on line 8 in docs/pages/community.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/community.md#L8 

[write-good.ThereIs] Don't start a sentence with 'There are'.
Raw output 
{"message": "[write-good.ThereIs] Don't start a sentence with 'There are'.", "location": {"path": "docs/pages/community.md", "range": {"start": {"line": 8, "column": 1}}}, "severity": "ERROR"}

Check warning on line 64 in CODE_OF_CONDUCT.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] CODE_OF_CONDUCT.md#L64 

[write-good.Weasel] 'fairly' is a weasel word!
Raw output 
{"message": "[write-good.Weasel] 'fairly' is a weasel word!", "location": {"path": "CODE_OF_CONDUCT.md", "range": {"start": {"line": 64, "column": 14}}}, "severity": "WARNING"}

Check failure on line 8 in docs/pages/docs.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/docs.md#L8 

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

Check warning on line 8 in docs/pages/docs.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/docs.md#L8 

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

Check warning on line 31 in docs/pages/docs.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/docs.md#L31 

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

Check failure on line 31 in docs/pages/docs.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/docs.md#L31 

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

Check failure on line 29 in docs/pages/libraries/jupyter-notebooks.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/libraries/jupyter-notebooks.md#L29 

[write-good.ThereIs] Don't start a sentence with 'There is'.
Raw output 
{"message": "[write-good.ThereIs] Don't start a sentence with 'There is'.", "location": {"path": "docs/pages/libraries/jupyter-notebooks.md", "range": {"start": {"line": 29, "column": 1}}}, "severity": "ERROR"}

Check failure on line 29 in docs/pages/libraries/parallel-async.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/libraries/parallel-async.md#L29 

[proselint.Typography] Consider using the '…' symbol instead of '...'.
Raw output 
{"message": "[proselint.Typography] Consider using the '…' symbol instead of '...'.", "location": {"path": "docs/pages/libraries/parallel-async.md", "range": {"start": {"line": 29, "column": 119}}}, "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"}

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 10 in docs/pages/packaging.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/pages/packaging.md#L10 

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

Check failure on line 10 in tutorial.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] tutorial.md#L10 

[proselint.Typography] Consider using the '…' symbol instead of '...'.
Raw output 
{"message": "[proselint.Typography] Consider using the '…' symbol instead of '...'.", "location": {"path": "tutorial.md", "range": {"start": {"line": 10, "column": 34}}}, "severity": "ERROR"}

Check failure on line 201 in tutorial.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] tutorial.md#L201 

[write-good.ThereIs] Don't start a sentence with 'There are'.
Raw output 
{"message": "[write-good.ThereIs] Don't start a sentence with 'There are'.", "location": {"path": "tutorial.md", "range": {"start": {"line": 201, "column": 1}}}, "severity": "ERROR"}

Check warning on line 201 in tutorial.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] tutorial.md#L201 

[write-good.Weasel] 'extremely' is a weasel word!
Raw output 
{"message": "[write-good.Weasel] 'extremely' is a weasel word!", "location": {"path": "tutorial.md", "range": {"start": {"line": 201, "column": 269}}}, "severity": "WARNING"}
View more details on GitHub Actions