Skip to content

Add scaffolding for improved documentation

Sign in for the full log view
GitHub Actions / vale completed Feb 2, 2024 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (4)

doc/source/api/index.rst|1 col 1| [Google.Headings] 'API reference' should use sentence-style capitalization.
doc/source/api/tree_objects.rst|1 col 1| [Google.Headings] 'ACP objects' should use sentence-style capitalization.
doc/source/contribute.rst|12 col 55| [Google.We] Try to avoid using first-person plural like 'our'.
doc/source/contribute.rst|17 col 55| [Google.We] Try to avoid using first-person plural like 'our'.

Filtered Findings (0)

Annotations

Check warning on line 1 in doc/source/api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api/index.rst#L1 

[Google.Headings] 'API reference' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'API reference' should use sentence-style capitalization.", "location": {"path": "doc/source/api/index.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in doc/source/api/tree_objects.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api/tree_objects.rst#L1 

[Google.Headings] 'ACP objects' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'ACP objects' should use sentence-style capitalization.", "location": {"path": "doc/source/api/tree_objects.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 12 in doc/source/contribute.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/contribute.rst#L12 

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "doc/source/contribute.rst", "range": {"start": {"line": 12, "column": 55}}}, "severity": "WARNING"}

Check warning on line 17 in doc/source/contribute.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/contribute.rst#L17 

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "doc/source/contribute.rst", "range": {"start": {"line": 17, "column": 55}}}, "severity": "WARNING"}
View more details on GitHub Actions