Chore/bring over code from old repo #23
reviewdog [vale] report
reported by reviewdog 🐶
Findings (38)
doc/source/index.rst|10 col 1| [Google.Headings] 'PySimAI documentation' should use sentence-style capitalization.
doc/source/index.rst|18 col 1| [Google.Headings] 'What is PySimAI ?' should use sentence-style capitalization.
doc/source/index.rst|21 col 77| [Google.We] Try to avoid using first-person plural like 'let's'.
doc/source/index.rst|28 col 1| [Google.Headings] 'SDK Installation' should use sentence-style capitalization.
doc/source/index.rst|50 col 5| [Google.Will] Avoid using 'will'.
doc/source/api_reference/training_data_parts.rst|3 col 1| [Google.Headings] 'Training Data Part' should use sentence-style capitalization.
doc/source/api_reference/training_data.rst|3 col 1| [Google.Headings] 'Training Data' should use sentence-style capitalization.
doc/source/api_reference/design_of_experiments.rst|3 col 1| [Google.Headings] 'Design of Experiments' should use sentence-style capitalization.
doc/source/api_reference/data_types.rst|1 col 1| [Google.Headings] 'Data Types' should use sentence-style capitalization.
doc/source/api_reference/workspaces.rst|8 col 1| [Google.OxfordComma] Use the Oxford comma in 'Workspaces are a set of specific geometries, predictions and'.
doc/source/api_reference/workspaces.rst|27 col 1| [Google.Headings] 'ModelManifest' should use sentence-style capitalization.
doc/source/api_reference/geometries.rst|19 col 73| [Google.We] Try to avoid using first-person plural like 'us'.
doc/source/api_reference/post_processings.rst|3 col 1| [Google.Headings] 'Post-Processings' should use sentence-style capitalization.
doc/source/api_reference/post_processings.rst|23 col 1| [Google.Headings] 'Nested Prediction Namespace' should use sentence-style capitalization.
doc/source/api_reference/post_processings.rst|35 col 19| [Google.WordList] Use 'select' instead of 'check'.
doc/source/api_reference.rst|3 col 1| [Google.Headings] 'API Reference' should use sentence-style capitalization.
doc/source/user_guide/best_practices.rst|3 col 1| [Google.Headings] 'Best Practices' should use sentence-style capitalization.
doc/source/user_guide/best_practices.rst|10 col 89| [Google.Will] Avoid using 'will'.
doc/source/user_guide/best_practices.rst|41 col 63| [Google.Will] Avoid using 'will'.
doc/source/user_guide/best_practices.rst|69 col 16| [Google.Will] Avoid using 'will'.
doc/source/user_guide/training.rst|22 col 5| [Google.Will] Avoid using 'will'.
doc/source/user_guide/proxy.rst|6 col 21| [Google.Will] Avoid using 'will'.
doc/source/user_guide/proxy.rst|8 col 1| [Google.Headings] 'SDK configuration' should use sentence-style capitalization.
doc/source/user_guide/proxy.rst|21 col 34| [Google.Will] Avoid using 'will'.
doc/source/user_guide/config_file.rst|3 col 1| [Google.Headings] 'Configuration File' should use sentence-style capitalization.
doc/source/user_guide/config_file.rst|16 col 46| [Google.Will] Avoid using 'will'.
doc/source/user_guide/config_file.rst|32 col 30| [Google.Will] Avoid using 'will'.
doc/source/user_guide/config_file.rst|75 col 54| [Google.Will] Avoid using 'will'.
doc/source/user_guide/data_exploration.rst|3 col 1| [Google.Headings] 'Data Exploration' should use sentence-style capitalization.
doc/source/user_guide/data_exploration.rst|45 col 106| [Google.Colons] ': T' should be in lowercase.
doc/source/user_guide/configuration.rst|4 col 1| [Google.Headings] 'Client Configuration' should use sentence-style capitalization.
doc/source/user_guide/configuration.rst|10 col 49| [Google.Will] Avoid using 'will'.
doc/source/user_guide/configuration.rst|22 col 37| [Google.We] Try to avoid using first-person plural like 'we'.
doc/source/api_reference/optimizations.rst|21 col 1| [Google.Headings] 'TrialRun' should use sentence-style capitalization.
doc/source/api_reference/selections.rst|6 col 1| [Google.Headings] 'Selections Basics' should use sentence-style capitalization.
doc/source/api_reference/selections.rst|44 col 1| [Google.Headings] 'Selections API Reference' should use sentence-style capitalization.
doc/source/api_reference/selections.rst|59 col 1| [Google.Headings] 'Post-processing Basics' should use sentence-style capitalization.
doc/source/api_reference/selections.rst|112 col 1| [Google.Headings] 'Post-processing API Reference' should use sentence-style capitalization.
Filtered Findings (0)
Annotations
Check warning on line 10 in doc/source/index.rst
github-actions / vale
[vale] doc/source/index.rst#L10
[Google.Headings] 'PySimAI documentation' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'PySimAI documentation' should use sentence-style capitalization.", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 10, "column": 1}}}, "severity": "WARNING"}
Check warning on line 18 in doc/source/index.rst
github-actions / vale
[vale] doc/source/index.rst#L18
[Google.Headings] 'What is PySimAI ?' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'What is PySimAI ?' should use sentence-style capitalization.", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 18, "column": 1}}}, "severity": "WARNING"}
Check warning on line 21 in doc/source/index.rst
github-actions / vale
[vale] doc/source/index.rst#L21
[Google.We] Try to avoid using first-person plural like 'let's'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'let's'.", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 21, "column": 77}}}, "severity": "WARNING"}
Check warning on line 28 in doc/source/index.rst
github-actions / vale
[vale] doc/source/index.rst#L28
[Google.Headings] 'SDK Installation' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'SDK Installation' should use sentence-style capitalization.", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 28, "column": 1}}}, "severity": "WARNING"}
Check warning on line 50 in doc/source/index.rst
github-actions / vale
[vale] doc/source/index.rst#L50
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 50, "column": 5}}}, "severity": "WARNING"}
Check warning on line 3 in doc/source/api_reference/training_data_parts.rst
github-actions / vale
[vale] doc/source/api_reference/training_data_parts.rst#L3
[Google.Headings] 'Training Data Part' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Training Data Part' 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
github-actions / vale
[vale] doc/source/api_reference/training_data.rst#L3
[Google.Headings] 'Training Data' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Training Data' 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 3 in doc/source/api_reference/design_of_experiments.rst
github-actions / vale
[vale] doc/source/api_reference/design_of_experiments.rst#L3
[Google.Headings] 'Design of Experiments' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Design of Experiments' should use sentence-style capitalization.", "location": {"path": "doc/source/api_reference/design_of_experiments.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}
Check warning on line 1 in doc/source/api_reference/data_types.rst
github-actions / vale
[vale] doc/source/api_reference/data_types.rst#L1
[Google.Headings] 'Data Types' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Data Types' should use sentence-style capitalization.", "location": {"path": "doc/source/api_reference/data_types.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
Check warning on line 8 in doc/source/api_reference/workspaces.rst
github-actions / vale
[vale] doc/source/api_reference/workspaces.rst#L8
[Google.OxfordComma] Use the Oxford comma in 'Workspaces are a set of specific geometries, predictions and'.
Raw output
{"message": "[Google.OxfordComma] Use the Oxford comma in 'Workspaces are a set of specific geometries, predictions and'.", "location": {"path": "doc/source/api_reference/workspaces.rst", "range": {"start": {"line": 8, "column": 1}}}, "severity": "WARNING"}
Check warning on line 27 in doc/source/api_reference/workspaces.rst
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 19 in doc/source/api_reference/geometries.rst
github-actions / vale
[vale] doc/source/api_reference/geometries.rst#L19
[Google.We] Try to avoid using first-person plural like 'us'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'us'.", "location": {"path": "doc/source/api_reference/geometries.rst", "range": {"start": {"line": 19, "column": 73}}}, "severity": "WARNING"}
Check warning on line 3 in doc/source/api_reference/post_processings.rst
github-actions / vale
[vale] doc/source/api_reference/post_processings.rst#L3
[Google.Headings] 'Post-Processings' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Post-Processings' 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 23 in doc/source/api_reference/post_processings.rst
github-actions / vale
[vale] doc/source/api_reference/post_processings.rst#L23
[Google.Headings] 'Nested Prediction Namespace' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Nested Prediction Namespace' should use sentence-style capitalization.", "location": {"path": "doc/source/api_reference/post_processings.rst", "range": {"start": {"line": 23, "column": 1}}}, "severity": "WARNING"}
Check warning on line 35 in doc/source/api_reference/post_processings.rst
github-actions / vale
[vale] doc/source/api_reference/post_processings.rst#L35
[Google.WordList] Use 'select' instead of 'check'.
Raw output
{"message": "[Google.WordList] Use 'select' instead of 'check'.", "location": {"path": "doc/source/api_reference/post_processings.rst", "range": {"start": {"line": 35, "column": 19}}}, "severity": "WARNING"}
Check warning on line 3 in doc/source/api_reference.rst
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"}
Check warning on line 3 in doc/source/user_guide/best_practices.rst
github-actions / vale
[vale] doc/source/user_guide/best_practices.rst#L3
[Google.Headings] 'Best Practices' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Best Practices' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide/best_practices.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}
Check warning on line 10 in doc/source/user_guide/best_practices.rst
github-actions / vale
[vale] doc/source/user_guide/best_practices.rst#L10
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user_guide/best_practices.rst", "range": {"start": {"line": 10, "column": 89}}}, "severity": "WARNING"}
Check warning on line 41 in doc/source/user_guide/best_practices.rst
github-actions / vale
[vale] doc/source/user_guide/best_practices.rst#L41
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user_guide/best_practices.rst", "range": {"start": {"line": 41, "column": 63}}}, "severity": "WARNING"}
Check warning on line 69 in doc/source/user_guide/best_practices.rst
github-actions / vale
[vale] doc/source/user_guide/best_practices.rst#L69
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user_guide/best_practices.rst", "range": {"start": {"line": 69, "column": 16}}}, "severity": "WARNING"}
Check warning on line 22 in doc/source/user_guide/training.rst
github-actions / vale
[vale] doc/source/user_guide/training.rst#L22
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user_guide/training.rst", "range": {"start": {"line": 22, "column": 5}}}, "severity": "WARNING"}
Check warning on line 6 in doc/source/user_guide/proxy.rst
github-actions / vale
[vale] doc/source/user_guide/proxy.rst#L6
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user_guide/proxy.rst", "range": {"start": {"line": 6, "column": 21}}}, "severity": "WARNING"}
Check warning on line 8 in doc/source/user_guide/proxy.rst
github-actions / vale
[vale] doc/source/user_guide/proxy.rst#L8
[Google.Headings] 'SDK configuration' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'SDK configuration' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide/proxy.rst", "range": {"start": {"line": 8, "column": 1}}}, "severity": "WARNING"}
Check warning on line 21 in doc/source/user_guide/proxy.rst
github-actions / vale
[vale] doc/source/user_guide/proxy.rst#L21
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user_guide/proxy.rst", "range": {"start": {"line": 21, "column": 34}}}, "severity": "WARNING"}
Check warning on line 3 in doc/source/user_guide/config_file.rst
github-actions / vale
[vale] doc/source/user_guide/config_file.rst#L3
[Google.Headings] 'Configuration File' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Configuration File' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide/config_file.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}