Skip to content

feat: doc getting started user guide email

Sign in for the full log view
This check has been archived and is scheduled for deletion. Learn more about checks retention
GitHub Actions / vale failed Jul 20, 2023 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (13)

doc/source/contributing.rst|58 col 44| [Google.WordList] Use 'select' instead of 'check'.
doc/source/getting_started/index.rst|7 col 20| [Vale.Spelling] Did you really mean 'Pythonic'?
doc/source/getting_started/faqs.rst|6 col 1| [Google.Headings] 'What is PyAnsys?' should use sentence-style capitalization.
doc/source/getting_started/faqs.rst|8 col 74| [Vale.Spelling] Did you really mean 'Pythonically'?
doc/source/getting_started/faqs.rst|17 col 1| [Google.Headings] 'What is PyUnits?' should use sentence-style capitalization.
doc/source/examples/basic-usage.rst|4 col 1| [Google.Headings] 'Basic Usage' should use sentence-style capitalization.
doc/source/user_guide/map.rst|4 col 1| [Google.Headings] 'Quantity Map' should use sentence-style capitalization.
doc/source/user_guide/config.rst|4 col 1| [Vale.Spelling] Did you really mean 'Config'?
doc/source/user_guide/index.rst|4 col 1| [Google.Headings] 'User Guide' should use sentence-style capitalization.
doc/source/user_guide/systems.rst|4 col 1| [Google.Headings] 'Unit Systems' should use sentence-style capitalization.
doc/source/index.rst|1 col 1| [Google.Headings] 'PyUnits Documentation *********' should use sentence-style capitalization.
doc/source/index.rst|15 col 20| [Vale.Spelling] Did you really mean 'pythonic'?
doc/source/index.rst|22 col 1| [Google.Headings] 'Documentation and Issues' should use sentence-style capitalization.

Filtered Findings (0)

Annotations

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

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/contributing.rst#L58 

[Google.WordList] Use 'select' instead of 'check'.
Raw output 
{"message": "[Google.WordList] Use 'select' instead of 'check'.", "location": {"path": "doc/source/contributing.rst", "range": {"start": {"line": 58, "column": 44}}}, "severity": "WARNING"}

Check failure on line 7 in doc/source/getting_started/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/getting_started/index.rst#L7 

[Vale.Spelling] Did you really mean 'Pythonic'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Pythonic'?", "location": {"path": "doc/source/getting_started/index.rst", "range": {"start": {"line": 7, "column": 20}}}, "severity": "ERROR"}

Check warning on line 6 in doc/source/getting_started/faqs.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/getting_started/faqs.rst#L6 

[Google.Headings] 'What is PyAnsys?' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'What is PyAnsys?' should use sentence-style capitalization.", "location": {"path": "doc/source/getting_started/faqs.rst", "range": {"start": {"line": 6, "column": 1}}}, "severity": "WARNING"}

Check failure on line 8 in doc/source/getting_started/faqs.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/getting_started/faqs.rst#L8 

[Vale.Spelling] Did you really mean 'Pythonically'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Pythonically'?", "location": {"path": "doc/source/getting_started/faqs.rst", "range": {"start": {"line": 8, "column": 74}}}, "severity": "ERROR"}

Check warning on line 17 in doc/source/getting_started/faqs.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/getting_started/faqs.rst#L17 

[Google.Headings] 'What is PyUnits?' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'What is PyUnits?' should use sentence-style capitalization.", "location": {"path": "doc/source/getting_started/faqs.rst", "range": {"start": {"line": 17, "column": 1}}}, "severity": "WARNING"}

Check warning on line 4 in doc/source/examples/basic-usage.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/examples/basic-usage.rst#L4 

[Google.Headings] 'Basic Usage' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Basic Usage' should use sentence-style capitalization.", "location": {"path": "doc/source/examples/basic-usage.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "WARNING"}

Check warning on line 4 in doc/source/user_guide/map.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/user_guide/map.rst#L4 

[Google.Headings] 'Quantity Map' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Quantity Map' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide/map.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "WARNING"}

Check failure on line 4 in doc/source/user_guide/config.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/user_guide/config.rst#L4 

[Vale.Spelling] Did you really mean 'Config'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Config'?", "location": {"path": "doc/source/user_guide/config.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "ERROR"}

Check warning on line 4 in doc/source/user_guide/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/user_guide/index.rst#L4 

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

Check warning on line 4 in doc/source/user_guide/systems.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/user_guide/systems.rst#L4 

[Google.Headings] 'Unit Systems' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Unit Systems' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide/systems.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "WARNING"}

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

See this annotation in the file changed.

@github-actions github-actions / vale

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

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

Check failure on line 15 in doc/source/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/index.rst#L15 

[Vale.Spelling] Did you really mean 'pythonic'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'pythonic'?", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 15, "column": 20}}}, "severity": "ERROR"}

Check warning on line 22 in doc/source/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/index.rst#L22 

[Google.Headings] 'Documentation and Issues' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Documentation and Issues' should use sentence-style capitalization.", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 22, "column": 1}}}, "severity": "WARNING"}
View more details on GitHub Actions