Skip to content
Labeler

doc refactoring #26

Sign in to view logs

doc refactoring

doc refactoring #26

GitHub Actions / vale failed Oct 19, 2023 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (23)

doc/source/EDBAPI/PrimitivesEdb.rst|1 col 1| [Google.Headings] 'Modeler & primitives' should use sentence-style capitalization.
doc/source/EDBAPI/index.rst|2 col 1| [Google.Headings] 'EDB API' should use sentence-style capitalization.
doc/source/EDBAPI/LayerData.rst|1 col 1| [Google.Headings] 'Stackup & layers' should use sentence-style capitalization.
doc/source/index.rst|1 col 1| [Google.Headings] 'PyAEDT documentation |version|' should use sentence-style capitalization.
doc/source/User_guide/optimetrics.rst|1 col 1| [Google.Headings] 'Optimetrics' should use sentence-style capitalization.
doc/source/Getting_started/About.rst|1 col 1| [Google.Headings] 'About PyEDB' should use sentence-style capitalization.
doc/source/Getting_started/About.rst|4 col 1| [Google.Headings] 'PyEDB' should use sentence-style capitalization.
doc/source/Getting_started/About.rst|23 col 61| [Vale.Terms] Use 'Siwave' instead of 'SIwave'.
doc/source/Getting_started/About.rst|25 col 46| [Vale.Terms] Use 'AEDB' instead of 'aedb'.
doc/source/Getting_started/About.rst|29 col 88| [Vale.Terms] Use 'Siwave' instead of 'SIwave'.
doc/source/Getting_started/About.rst|29 col 98| [Vale.Spelling] Did you really mean 'bacth'?
doc/source/Getting_started/About.rst|30 col 88| [Vale.Spelling] Did you really mean 'simulatiom'?
doc/source/Getting_started/About.rst|56 col 1| [Google.Headings] 'Why PyEDB?' should use sentence-style capitalization.
doc/source/Getting_started/Quickcode.rst|1 col 1| [Google.Headings] 'Quick Code' should use sentence-style capitalization.
doc/source/Getting_started/Quickcode.rst|38 col 1| [Google.Headings] 'Connect to AEDT from a Python IDE' should use sentence-style capitalization.
doc/source/Getting_started/index.rst|49 col 1| [Google.Headings] 'What is PyAEDT?' should use sentence-style capitalization.
doc/source/Getting_started/Installation.rst|45 col 1| [Google.Headings] 'Build Toolkits with PyAEDT' should use sentence-style capitalization.
doc/source/Getting_started/Installation.rst|161 col 1| [Google.Headings] 'Use IronPython in AEDT' should use sentence-style capitalization.
doc/source/Getting_started/Contributing.rst|34 col 1| [Google.Headings] 'View PyAEDT documentation' should use sentence-style capitalization.
doc/source/Getting_started/Troubleshooting.rst|59 col 1| [Google.Headings] 'Run PyAEDT' should use sentence-style capitalization.
doc/source/Getting_started/Troubleshooting.rst|62 col 1| [Google.Headings] 'COM vs gRPC' should use sentence-style capitalization.
doc/source/Getting_started/Troubleshooting.rst|93 col 1| [Google.Headings] 'Check the AEDT API configuration' should use sentence-style capitalization.
doc/source/Getting_started/versioning.rst|28 col 1| [Google.Headings] 'COM interface' should use sentence-style capitalization.

Filtered Findings (0)

Annotations

Check warning on line 1 in doc/source/EDBAPI/PrimitivesEdb.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/EDBAPI/PrimitivesEdb.rst#L1 

[Google.Headings] 'Modeler & primitives' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Modeler \u0026 primitives' should use sentence-style capitalization.", "location": {"path": "doc/source/EDBAPI/PrimitivesEdb.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 2 in doc/source/EDBAPI/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/EDBAPI/index.rst#L2 

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

Check warning on line 1 in doc/source/EDBAPI/LayerData.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/EDBAPI/LayerData.rst#L1 

[Google.Headings] 'Stackup & layers' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Stackup \u0026 layers' should use sentence-style capitalization.", "location": {"path": "doc/source/EDBAPI/LayerData.rst", "range": {"start": {"line": 1, "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] 'PyAEDT documentation |version|' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'PyAEDT documentation |version|' should use sentence-style capitalization.", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in doc/source/User_guide/optimetrics.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/User_guide/optimetrics.rst#L1 

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

Check warning on line 1 in doc/source/Getting_started/About.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/About.rst#L1 

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

Check warning on line 4 in doc/source/Getting_started/About.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/About.rst#L4 

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

Check failure on line 23 in doc/source/Getting_started/About.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/About.rst#L23 

[Vale.Terms] Use 'Siwave' instead of 'SIwave'.
Raw output 
{"message": "[Vale.Terms] Use 'Siwave' instead of 'SIwave'.", "location": {"path": "doc/source/Getting_started/About.rst", "range": {"start": {"line": 23, "column": 61}}}, "severity": "ERROR"}

Check failure on line 25 in doc/source/Getting_started/About.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/About.rst#L25 

[Vale.Terms] Use 'AEDB' instead of 'aedb'.
Raw output 
{"message": "[Vale.Terms] Use 'AEDB' instead of 'aedb'.", "location": {"path": "doc/source/Getting_started/About.rst", "range": {"start": {"line": 25, "column": 46}}}, "severity": "ERROR"}

Check failure on line 29 in doc/source/Getting_started/About.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/About.rst#L29 

[Vale.Terms] Use 'Siwave' instead of 'SIwave'.
Raw output 
{"message": "[Vale.Terms] Use 'Siwave' instead of 'SIwave'.", "location": {"path": "doc/source/Getting_started/About.rst", "range": {"start": {"line": 29, "column": 88}}}, "severity": "ERROR"}

Check failure on line 29 in doc/source/Getting_started/About.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/About.rst#L29 

[Vale.Spelling] Did you really mean 'bacth'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'bacth'?", "location": {"path": "doc/source/Getting_started/About.rst", "range": {"start": {"line": 29, "column": 98}}}, "severity": "ERROR"}

Check failure on line 30 in doc/source/Getting_started/About.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/About.rst#L30 

[Vale.Spelling] Did you really mean 'simulatiom'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'simulatiom'?", "location": {"path": "doc/source/Getting_started/About.rst", "range": {"start": {"line": 30, "column": 88}}}, "severity": "ERROR"}

Check warning on line 56 in doc/source/Getting_started/About.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/About.rst#L56 

[Google.Headings] 'Why PyEDB?' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Why PyEDB?' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/About.rst", "range": {"start": {"line": 56, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in doc/source/Getting_started/Quickcode.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/Quickcode.rst#L1 

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

Check warning on line 38 in doc/source/Getting_started/Quickcode.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/Quickcode.rst#L38 

[Google.Headings] 'Connect to AEDT from a Python IDE' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Connect to AEDT from a Python IDE' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/Quickcode.rst", "range": {"start": {"line": 38, "column": 1}}}, "severity": "WARNING"}

Check warning on line 49 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#L49 

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

Check warning on line 45 in doc/source/Getting_started/Installation.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/Installation.rst#L45 

[Google.Headings] 'Build Toolkits with PyAEDT' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Build Toolkits with PyAEDT' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/Installation.rst", "range": {"start": {"line": 45, "column": 1}}}, "severity": "WARNING"}

Check warning on line 161 in doc/source/Getting_started/Installation.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/Installation.rst#L161 

[Google.Headings] 'Use IronPython in AEDT' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Use IronPython in AEDT' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/Installation.rst", "range": {"start": {"line": 161, "column": 1}}}, "severity": "WARNING"}

Check warning on line 34 in doc/source/Getting_started/Contributing.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/Contributing.rst#L34 

[Google.Headings] 'View PyAEDT documentation' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'View PyAEDT documentation' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/Contributing.rst", "range": {"start": {"line": 34, "column": 1}}}, "severity": "WARNING"}

Check warning on line 59 in doc/source/Getting_started/Troubleshooting.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/Troubleshooting.rst#L59 

[Google.Headings] 'Run PyAEDT' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Run PyAEDT' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/Troubleshooting.rst", "range": {"start": {"line": 59, "column": 1}}}, "severity": "WARNING"}

Check warning on line 62 in doc/source/Getting_started/Troubleshooting.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/Troubleshooting.rst#L62 

[Google.Headings] 'COM vs gRPC' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'COM vs gRPC' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/Troubleshooting.rst", "range": {"start": {"line": 62, "column": 1}}}, "severity": "WARNING"}

Check warning on line 93 in doc/source/Getting_started/Troubleshooting.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/Troubleshooting.rst#L93 

[Google.Headings] 'Check the AEDT API configuration' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Check the AEDT API configuration' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/Troubleshooting.rst", "range": {"start": {"line": 93, "column": 1}}}, "severity": "WARNING"}

Check warning on line 28 in doc/source/Getting_started/versioning.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/versioning.rst#L28 

[Google.Headings] 'COM interface' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'COM interface' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/versioning.rst", "range": {"start": {"line": 28, "column": 1}}}, "severity": "WARNING"}
View more details on GitHub Actions