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

Jump to bottom

Overall doc review #15

Merged
merged 18 commits into from
Jan 12, 2024

Apply suggestions from code review

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

Overall doc review #15

Apply suggestions from code review
7f70b38
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Jan 12, 2024 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (8)

doc/source/api_reference/selections.rst|44 col 1| [Google.Headings] 'Selection API reference' should use sentence-style capitalization.
doc/source/api_reference/selections.rst|115 col 1| [Google.Headings] 'Postprocessing API reference' should use sentence-style capitalization.
doc/source/api_reference/optimizations.rst|21 col 1| [Google.Headings] 'TrialRuns' should use sentence-style capitalization.
doc/source/api_reference/training_data_parts.rst|3 col 1| [Google.Headings] 'TrainingDataParts' should use sentence-style capitalization.
doc/source/api_reference/training_data.rst|3 col 1| [Google.Headings] 'TrainingData' should use sentence-style capitalization.
doc/source/api_reference/workspaces.rst|27 col 1| [Google.Headings] 'ModelManifest' should use sentence-style capitalization.
doc/source/api_reference/post_processings.rst|3 col 1| [Google.Headings] 'Postprocessings' should use sentence-style capitalization.
doc/source/api_reference.rst|3 col 1| [Google.Headings] 'API reference' should use sentence-style capitalization.

Filtered Findings (0)

Annotations

Check warning on line 44 in doc/source/api_reference/selections.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api_reference/selections.rst#L44 

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

Check warning on line 115 in doc/source/api_reference/selections.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api_reference/selections.rst#L115 

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

Check warning on line 21 in doc/source/api_reference/optimizations.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api_reference/optimizations.rst#L21 

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

Check warning on line 3 in doc/source/api_reference/training_data_parts.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api_reference/training_data_parts.rst#L3 

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

Check warning on line 3 in doc/source/api_reference/training_data.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api_reference/training_data.rst#L3 

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

Check warning on line 27 in doc/source/api_reference/workspaces.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api_reference/workspaces.rst#L27 

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

Check warning on line 3 in doc/source/api_reference/post_processings.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api_reference/post_processings.rst#L3 

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

Check warning on line 3 in doc/source/api_reference.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/api_reference.rst#L3 

[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_reference.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}
View more details on GitHub Actions