Skip to content

doc refactoring

doc refactoring #26

Triggered via pull request October 19, 2023 09:14
Status Success
Total duration 1m 1s
Artifacts

label.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

5 errors and 19 warnings
[vale] doc/source/Getting_started/About.rst#L23: doc/source/Getting_started/About.rst#L23
[Vale.Terms] Use 'Siwave' instead of 'SIwave'.
[vale] doc/source/Getting_started/About.rst#L25: doc/source/Getting_started/About.rst#L25
[Vale.Terms] Use 'AEDB' instead of 'aedb'.
[vale] doc/source/Getting_started/About.rst#L29: doc/source/Getting_started/About.rst#L29
[Vale.Terms] Use 'Siwave' instead of 'SIwave'.
[vale] doc/source/Getting_started/About.rst#L29: doc/source/Getting_started/About.rst#L29
[Vale.Spelling] Did you really mean 'bacth'?
[vale] doc/source/Getting_started/About.rst#L30: doc/source/Getting_started/About.rst#L30
[Vale.Spelling] Did you really mean 'simulatiom'?
[vale] doc/source/EDBAPI/PrimitivesEdb.rst#L1: doc/source/EDBAPI/PrimitivesEdb.rst#L1
[Google.Headings] 'Modeler & primitives' should use sentence-style capitalization.
[vale] doc/source/EDBAPI/index.rst#L2: doc/source/EDBAPI/index.rst#L2
[Google.Headings] 'EDB API' should use sentence-style capitalization.
[vale] doc/source/EDBAPI/LayerData.rst#L1: doc/source/EDBAPI/LayerData.rst#L1
[Google.Headings] 'Stackup & layers' should use sentence-style capitalization.
[vale] doc/source/index.rst#L1: doc/source/index.rst#L1
[Google.Headings] 'PyAEDT documentation |version|' should use sentence-style capitalization.
[vale] doc/source/User_guide/optimetrics.rst#L1: doc/source/User_guide/optimetrics.rst#L1
[Google.Headings] 'Optimetrics' should use sentence-style capitalization.
[vale] doc/source/Getting_started/About.rst#L1: doc/source/Getting_started/About.rst#L1
[Google.Headings] 'About PyEDB' should use sentence-style capitalization.
[vale] doc/source/Getting_started/About.rst#L4: doc/source/Getting_started/About.rst#L4
[Google.Headings] 'PyEDB' should use sentence-style capitalization.
[vale] doc/source/Getting_started/About.rst#L56: doc/source/Getting_started/About.rst#L56
[Google.Headings] 'Why PyEDB?' should use sentence-style capitalization.
[vale] doc/source/Getting_started/Quickcode.rst#L1: doc/source/Getting_started/Quickcode.rst#L1
[Google.Headings] 'Quick Code' should use sentence-style capitalization.
[vale] doc/source/Getting_started/Quickcode.rst#L38: doc/source/Getting_started/Quickcode.rst#L38
[Google.Headings] 'Connect to AEDT from a Python IDE' should use sentence-style capitalization.
[vale] doc/source/Getting_started/index.rst#L49: doc/source/Getting_started/index.rst#L49
[Google.Headings] 'What is PyAEDT?' should use sentence-style capitalization.
[vale] doc/source/Getting_started/Installation.rst#L45: doc/source/Getting_started/Installation.rst#L45
[Google.Headings] 'Build Toolkits with PyAEDT' should use sentence-style capitalization.
[vale] doc/source/Getting_started/Installation.rst#L161: doc/source/Getting_started/Installation.rst#L161
[Google.Headings] 'Use IronPython in AEDT' should use sentence-style capitalization.
[vale] doc/source/Getting_started/Contributing.rst#L34: doc/source/Getting_started/Contributing.rst#L34
[Google.Headings] 'View PyAEDT documentation' should use sentence-style capitalization.
[vale] doc/source/Getting_started/Troubleshooting.rst#L59: doc/source/Getting_started/Troubleshooting.rst#L59
[Google.Headings] 'Run PyAEDT' should use sentence-style capitalization.
[vale] doc/source/Getting_started/Troubleshooting.rst#L62: doc/source/Getting_started/Troubleshooting.rst#L62
[Google.Headings] 'COM vs gRPC' should use sentence-style capitalization.
[vale] doc/source/Getting_started/Troubleshooting.rst#L93: doc/source/Getting_started/Troubleshooting.rst#L93
[Google.Headings] 'Check the AEDT API configuration' should use sentence-style capitalization.
[vale] doc/source/Getting_started/versioning.rst#L28: doc/source/Getting_started/versioning.rst#L28
[Google.Headings] 'COM interface' should use sentence-style capitalization.
Set labels
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-ecosystem/action-add-labels@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/