Skip to content
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

Test code examples in docs #387

Merged
merged 1 commit into from
Feb 6, 2024

[WIP] Add doctest

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

Test code examples in docs #387

[WIP] Add doctest
733bde9
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Feb 5, 2024 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (5)

doc/source/intro.rst|19 col 1| [Google.Headings] 'Start ACP' 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/contributing.rst|12 col 55| [Google.We] Try to avoid using first-person plural like 'our'.
doc/source/contributing.rst|17 col 55| [Google.We] Try to avoid using first-person plural like 'our'.
doc/source/api/index.rst|1 col 1| [Google.Headings] 'API reference' should use sentence-style capitalization.

Filtered Findings (0)

Annotations

Check warning on line 19 in doc/source/intro.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/intro.rst#L19 

[Google.Headings] 'Start ACP' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Start ACP' should use sentence-style capitalization.", "location": {"path": "doc/source/intro.rst", "range": {"start": {"line": 19, "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/contributing.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/contributing.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/contributing.rst", "range": {"start": {"line": 12, "column": 55}}}, "severity": "WARNING"}

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

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/contributing.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/contributing.rst", "range": {"start": {"line": 17, "column": 55}}}, "severity": "WARNING"}

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"}
View more details on GitHub Actions