Chore/bring over code from old repo #20
reviewdog [vale] report
reported by reviewdog 🐶
Findings (93)
doc/index.rst|10 col 1| [Google.Headings] 'PySimAI documentation' should use sentence-style capitalization.
doc/index.rst|15 col 49| [Vale.Spelling] Did you really mean 'Ansys'?
doc/index.rst|18 col 1| [Google.Headings] 'What is PySimAI ?' should use sentence-style capitalization.
doc/index.rst|21 col 77| [Google.We] Try to avoid using first-person plural like 'let's'.
doc/index.rst|21 col 143| [Vale.Spelling] Did you really mean 'cunjonction'?
doc/index.rst|28 col 1| [Google.Headings] 'SDK Installation' should use sentence-style capitalization.
doc/index.rst|42 col 36| [Google.Spacing] 't.S' should have one space.
doc/index.rst|50 col 5| [Google.Will] Avoid using 'will'.
doc/index.rst|53 col 42| [Google.Spacing] 't.S' should have one space.
doc/index.rst|54 col 52| [Google.Spacing] 's.G' should have one space.
doc/index.rst|75 col 100| [Google.Spacing] 's.P' should have one space.
doc/index.rst|77 col 82| [Google.Spacing] 's.P' should have one space.
doc/index.rst|88 col 82| [Google.Spacing] 's.P' should have one space.
doc/index.rst|89 col 4| [Google.Will] Avoid using 'will'.
doc/index.rst|89 col 74| [Google.Spacing] 's.D' should have one space.
doc/index.rst|94 col 12| [Google.Exclamation] Don't use exclamation points in text.
doc/api_reference/training_data_parts.rst|3 col 1| [Google.Headings] 'Training Data Part' should use sentence-style capitalization.
doc/api_reference/training_data_parts.rst|8 col 93| [Google.Spacing] 'a.T' should have one space.
doc/api_reference/training_data.rst|3 col 1| [Google.Headings] 'Training Data' should use sentence-style capitalization.
doc/api_reference/training_data.rst|8 col 89| [Google.Spacing] 's.T' should have one space.
doc/api_reference/design_of_experiments.rst|3 col 1| [Google.Headings] 'Design of Experiments' should use sentence-style capitalization.
doc/api_reference/data_types.rst|1 col 1| [Google.Headings] 'Data Types' should use sentence-style capitalization.
doc/api_reference/workspaces.rst|8 col 1| [Google.OxfordComma] Use the Oxford comma in 'Workspaces are a set of specific geometries, predictions and'.
doc/api_reference/workspaces.rst|12 col 73| [Google.Spacing] 't.S' should have one space.
doc/api_reference/workspaces.rst|27 col 1| [Google.Headings] 'ModelManifest' should use sentence-style capitalization.
doc/api_reference/geometries.rst|17 col 129| [Google.Spacing] 's.M' should have one space.
doc/api_reference/geometries.rst|19 col 73| [Google.We] Try to avoid using first-person plural like 'us'.
doc/api_reference/post_processings.rst|3 col 1| [Google.Headings] 'Post-Processings' should use sentence-style capitalization.
doc/api_reference/post_processings.rst|23 col 1| [Google.Headings] 'Nested Prediction Namespace' should use sentence-style capitalization.
doc/api_reference/post_processings.rst|23 col 19| [Vale.Spelling] Did you really mean 'Namespace'?
doc/api_reference/post_processings.rst|35 col 19| [Google.WordList] Use 'select' instead of 'check'.
doc/api_reference/post_processings.rst|35 col 107| [Google.Spacing] 's.P' should have one space.
doc/user_guide.rst|1 col 1| [Google.Headings] 'User Guide' should use sentence-style capitalization.
doc/api_reference/predictions.rst|7 col 74| [Google.Spacing] 's.G' should have one space.
doc/api_reference.rst|3 col 1| [Google.Headings] 'API Reference' should use sentence-style capitalization.
doc/user_guide/best_practices.rst|3 col 1| [Google.Headings] 'Best Practices' should use sentence-style capitalization.
doc/user_guide/best_practices.rst|6 col 1| [Vale.Spelling] Did you really mean 'Asynchronicity'?
doc/user_guide/best_practices.rst|10 col 89| [Google.Will] Avoid using 'will'.
doc/user_guide/best_practices.rst|16 col 2| [Google.Latin] Use 'for example' instead of 'e.g.'.
doc/user_guide/best_practices.rst|16 col 64| [Google.Spacing] 's.P' should have one space.
doc/user_guide/best_practices.rst|17 col 49| [Google.Spacing] 't.S' should have one space.
doc/user_guide/best_practices.rst|18 col 77| [Google.Will] Avoid using 'will'.
doc/user_guide/best_practices.rst|41 col 63| [Google.Will] Avoid using 'will'.
doc/user_guide/best_practices.rst|69 col 16| [Google.Will] Avoid using 'will'.
doc/user_guide/training.rst|11 col 112| [Google.Spacing] 'a.T' should have one space.
doc/user_guide/training.rst|11 col 213| [Google.Spacing] 's.P' should have one space.
doc/user_guide/training.rst|16 col 42| [Google.Spacing] 't.S' should have one space.
doc/user_guide/training.rst|22 col 5| [Google.Will] Avoid using 'will'.
doc/user_guide/proxy.rst|6 col 21| [Google.Will] Avoid using 'will'.
doc/user_guide/proxy.rst|8 col 1| [Google.Headings] 'SDK configuration' should use sentence-style capitalization.
doc/user_guide/proxy.rst|21 col 34| [Google.Will] Avoid using 'will'.
doc/user_guide/proxy.rst|34 col 16| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'certificate(s)'.
doc/user_guide/config_file.rst|3 col 1| [Google.Headings] 'Configuration File' should use sentence-style capitalization.
doc/user_guide/config_file.rst|7 col 34| [Google.Spacing] 't.S' should have one space.
doc/user_guide/config_file.rst|16 col 46| [Google.Will] Avoid using 'will'.
doc/user_guide/config_file.rst|32 col 30| [Google.Will] Avoid using 'will'.
doc/user_guide/config_file.rst|54 col 68| [Google.Spacing] 't.S' should have one space.
doc/user_guide/config_file.rst|55 col 1| [Vale.Repetition] 'be' is repeated!
doc/user_guide/config_file.rst|75 col 54| [Google.Will] Avoid using 'will'.
doc/user_guide/config_file.rst|82 col 4| [Vale.Spelling] Did you really mean 'https_proxy'?
doc/user_guide/data_exploration.rst|3 col 1| [Google.Headings] 'Data Exploration' should use sentence-style capitalization.
doc/user_guide/data_exploration.rst|12 col 51| [Google.Spacing] 's.S' should have one space.
doc/user_guide/data_exploration.rst|45 col 106| [Google.Colons] ': T' should be in lowercase.
doc/user_guide/data_exploration.rst|46 col 58| [Google.Spacing] 's.G' should have one space.
doc/user_guide/data_exploration.rst|62 col 66| [Google.Spacing] 's.G' should have one space.
doc/user_guide/configuration.rst|4 col 1| [Google.Headings] 'Client Configuration' should use sentence-style capitalization.
doc/user_guide/configuration.rst|10 col 49| [Google.Will] Avoid using 'will'.
doc/user_guide/configuration.rst|13 col 67| [Google.Spacing] 't.S' should have one space.
doc/user_guide/configuration.rst|22 col 37| [Google.We] Try to avoid using first-person plural like 'we'.
doc/user_guide/configuration.rst|29 col 71| [Google.Spacing] 't.S' should have one space.
doc/user_guide/configuration.rst|44 col 44| [Google.Spacing] 't.S' should have one space.
doc/user_guide/configuration.rst|44 col 59| [Google.Will] Avoid using 'will'.
doc/api_reference/optimizations.rst|21 col 1| [Google.Headings] 'TrialRun' should use sentence-style capitalization.
doc/api_reference/selections.rst|6 col 1| [Google.Headings] 'Selections Basics' should use sentence-style capitalization.
doc/api_reference/selections.rst|12 col 53| [Google.Spacing] 's.G' should have one space.
doc/api_reference/selections.rst|13 col 54| [Google.Spacing] 's.P' should have one space.
doc/api_reference/selections.rst|14 col 67| [Google.Spacing] 's.P' should have one space.
doc/api_reference/selections.rst|17 col 52| [Google.Spacing] 's.G' should have one space.
doc/api_reference/selections.rst|18 col 36| [Google.Spacing] 's.B' should have one space.
doc/api_reference/selections.rst|31 col 41| [Google.Spacing] 's.P' should have one space.
doc/api_reference/selections.rst|32 col 42| [Google.Spacing] 's.P' should have one space.
doc/api_reference/selections.rst|44 col 1| [Google.Headings] 'Selections API Reference' should use sentence-style capitalization.
doc/api_reference/selections.rst|47 col 54| [Google.Spacing] 's.S' should have one space.
doc/api_reference/selections.rst|47 col 133| [Google.Spacing] 's.P' should have one space.
doc/api_reference/selections.rst|59 col 1| [Google.Headings] 'Post-processing Basics' should use sentence-style capitalization.
doc/api_reference/selections.rst|62 col 29| [Vale.Spelling] Did you really mean 'namespace'?
doc/api_reference/selections.rst|63 col 71| [Google.Spacing] 's.S' should have one space.
doc/api_reference/selections.rst|74 col 51| [Google.Spacing] 's.G' should have one space.
doc/api_reference/selections.rst|75 col 54| [Google.Spacing] 's.S' should have one space.
doc/api_reference/selections.rst|76 col 69| [Google.Spacing] 's.E' should have one space.
doc/api_reference/selections.rst|84 col 81| [Vale.Spelling] Did you really mean 'csv'?
doc/api_reference/selections.rst|85 col 48| [Vale.Spelling] Did you really mean 'zipfile'?
doc/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/index.rst
github-actions / vale
[vale] doc/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/index.rst", "range": {"start": {"line": 10, "column": 1}}}, "severity": "WARNING"}
Check failure on line 15 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L15
[Vale.Spelling] Did you really mean 'Ansys'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Ansys'?", "location": {"path": "doc/index.rst", "range": {"start": {"line": 15, "column": 49}}}, "severity": "ERROR"}
Check warning on line 18 in doc/index.rst
github-actions / vale
[vale] doc/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/index.rst", "range": {"start": {"line": 18, "column": 1}}}, "severity": "WARNING"}
Check warning on line 21 in doc/index.rst
github-actions / vale
[vale] doc/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/index.rst", "range": {"start": {"line": 21, "column": 77}}}, "severity": "WARNING"}
Check failure on line 21 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L21
[Vale.Spelling] Did you really mean 'cunjonction'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'cunjonction'?", "location": {"path": "doc/index.rst", "range": {"start": {"line": 21, "column": 143}}}, "severity": "ERROR"}
Check warning on line 28 in doc/index.rst
github-actions / vale
[vale] doc/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/index.rst", "range": {"start": {"line": 28, "column": 1}}}, "severity": "WARNING"}
Check failure on line 42 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L42
[Google.Spacing] 't.S' should have one space.
Raw output
{"message": "[Google.Spacing] 't.S' should have one space.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 42, "column": 36}}}, "severity": "ERROR"}
Check warning on line 50 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L50
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 50, "column": 5}}}, "severity": "WARNING"}
Check failure on line 53 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L53
[Google.Spacing] 't.S' should have one space.
Raw output
{"message": "[Google.Spacing] 't.S' should have one space.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 53, "column": 42}}}, "severity": "ERROR"}
Check failure on line 54 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L54
[Google.Spacing] 's.G' should have one space.
Raw output
{"message": "[Google.Spacing] 's.G' should have one space.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 54, "column": 52}}}, "severity": "ERROR"}
Check failure on line 75 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L75
[Google.Spacing] 's.P' should have one space.
Raw output
{"message": "[Google.Spacing] 's.P' should have one space.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 75, "column": 100}}}, "severity": "ERROR"}
Check failure on line 77 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L77
[Google.Spacing] 's.P' should have one space.
Raw output
{"message": "[Google.Spacing] 's.P' should have one space.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 77, "column": 82}}}, "severity": "ERROR"}
Check failure on line 88 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L88
[Google.Spacing] 's.P' should have one space.
Raw output
{"message": "[Google.Spacing] 's.P' should have one space.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 88, "column": 82}}}, "severity": "ERROR"}
Check warning on line 89 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L89
[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 89, "column": 4}}}, "severity": "WARNING"}
Check failure on line 89 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L89
[Google.Spacing] 's.D' should have one space.
Raw output
{"message": "[Google.Spacing] 's.D' should have one space.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 89, "column": 74}}}, "severity": "ERROR"}
Check failure on line 94 in doc/index.rst
github-actions / vale
[vale] doc/index.rst#L94
[Google.Exclamation] Don't use exclamation points in text.
Raw output
{"message": "[Google.Exclamation] Don't use exclamation points in text.", "location": {"path": "doc/index.rst", "range": {"start": {"line": 94, "column": 12}}}, "severity": "ERROR"}
Check warning on line 3 in doc/api_reference/training_data_parts.rst
github-actions / vale
[vale] doc/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/api_reference/training_data_parts.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}
Check failure on line 8 in doc/api_reference/training_data_parts.rst
github-actions / vale
[vale] doc/api_reference/training_data_parts.rst#L8
[Google.Spacing] 'a.T' should have one space.
Raw output
{"message": "[Google.Spacing] 'a.T' should have one space.", "location": {"path": "doc/api_reference/training_data_parts.rst", "range": {"start": {"line": 8, "column": 93}}}, "severity": "ERROR"}
Check warning on line 3 in doc/api_reference/training_data.rst
github-actions / vale
[vale] doc/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/api_reference/training_data.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}
Check failure on line 8 in doc/api_reference/training_data.rst
github-actions / vale
[vale] doc/api_reference/training_data.rst#L8
[Google.Spacing] 's.T' should have one space.
Raw output
{"message": "[Google.Spacing] 's.T' should have one space.", "location": {"path": "doc/api_reference/training_data.rst", "range": {"start": {"line": 8, "column": 89}}}, "severity": "ERROR"}
Check warning on line 3 in doc/api_reference/design_of_experiments.rst
github-actions / vale
[vale] doc/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/api_reference/design_of_experiments.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}
Check warning on line 1 in doc/api_reference/data_types.rst
github-actions / vale
[vale] doc/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/api_reference/data_types.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
Check warning on line 8 in doc/api_reference/workspaces.rst
github-actions / vale
[vale] doc/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/api_reference/workspaces.rst", "range": {"start": {"line": 8, "column": 1}}}, "severity": "WARNING"}
Check failure on line 12 in doc/api_reference/workspaces.rst
github-actions / vale
[vale] doc/api_reference/workspaces.rst#L12
[Google.Spacing] 't.S' should have one space.
Raw output
{"message": "[Google.Spacing] 't.S' should have one space.", "location": {"path": "doc/api_reference/workspaces.rst", "range": {"start": {"line": 12, "column": 73}}}, "severity": "ERROR"}
Check warning on line 27 in doc/api_reference/workspaces.rst
github-actions / vale
[vale] doc/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/api_reference/workspaces.rst", "range": {"start": {"line": 27, "column": 1}}}, "severity": "WARNING"}