Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstring for MeshRegion class. #3785

Merged
merged 2 commits into from
Oct 23, 2023

Merge branch 'main' into enhancement/icepak_meshing

504ffb3
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

Add docstring for MeshRegion class. #3785

Merge branch 'main' into enhancement/icepak_meshing
504ffb3
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Oct 23, 2023 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (17)

doc/source/API/Primitives3D.rst|1 col 1| [Google.Headings] '3D modeler' should use sentence-style capitalization.
doc/source/API/Post.rst|52 col 1| [Google.Headings] 'AEDT report management' should use sentence-style capitalization.
doc/source/API/Primitives2D.rst|1 col 1| [Google.Headings] '2D modeler' should use sentence-style capitalization.
doc/source/API/SetupTemplatesQ3D.rst|1 col 1| [Google.Headings] 'Q3D templates and arguments' should use sentence-style capitalization.
doc/source/API/index.rst|2 col 1| [Google.Headings] 'AEDT API' should use sentence-style capitalization.
doc/source/API/Stackup3D.rst|1 col 1| [Google.Headings] 'Stackup 3D components' should use sentence-style capitalization.
doc/source/API/SetupTemplatesHFSS.rst|1 col 1| [Google.Headings] 'HFSS templates and arguments' should use sentence-style capitalization.
doc/source/EDBAPI/index.rst|2 col 1| [Google.Headings] 'EDB API' should use sentence-style capitalization.
doc/source/Getting_started/About.rst|1 col 1| [Google.Headings] 'About PyAnsys and AEDT' should use sentence-style capitalization.
doc/source/Getting_started/About.rst|15 col 1| [Google.Headings] 'About AEDT' should use sentence-style capitalization.
doc/source/Getting_started/ClientServer.rst|10 col 1| [Google.Headings] 'gRPC connection in AEDT 2022 R2 and later' 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/Installation.rst|100 col 1| [Google.Headings] 'Use IronPython in AEDT' should use sentence-style capitalization.
doc/source/Getting_started/versioning.rst|28 col 1| [Google.Headings] 'COM interface' 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.

Filtered Findings (0)

Annotations

Check warning on line 1 in doc/source/API/Primitives3D.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/API/Primitives3D.rst#L1 

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

Check warning on line 52 in doc/source/API/Post.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/API/Post.rst#L52 

[Google.Headings] 'AEDT report management' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'AEDT report management' should use sentence-style capitalization.", "location": {"path": "doc/source/API/Post.rst", "range": {"start": {"line": 52, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in doc/source/API/Primitives2D.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/API/Primitives2D.rst#L1 

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

Check warning on line 1 in doc/source/API/SetupTemplatesQ3D.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/API/SetupTemplatesQ3D.rst#L1 

[Google.Headings] 'Q3D templates and arguments' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Q3D templates and arguments' should use sentence-style capitalization.", "location": {"path": "doc/source/API/SetupTemplatesQ3D.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

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

See this annotation in the file changed.

@github-actions github-actions / vale

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

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

Check warning on line 1 in doc/source/API/Stackup3D.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/API/Stackup3D.rst#L1 

[Google.Headings] 'Stackup 3D components' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Stackup 3D components' should use sentence-style capitalization.", "location": {"path": "doc/source/API/Stackup3D.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in doc/source/API/SetupTemplatesHFSS.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/API/SetupTemplatesHFSS.rst#L1 

[Google.Headings] 'HFSS templates and arguments' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'HFSS templates and arguments' should use sentence-style capitalization.", "location": {"path": "doc/source/API/SetupTemplatesHFSS.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/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 PyAnsys and AEDT' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'About PyAnsys and AEDT' 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 15 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#L15 

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

Check warning on line 10 in doc/source/Getting_started/ClientServer.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/Getting_started/ClientServer.rst#L10 

[Google.Headings] 'gRPC connection in AEDT 2022 R2 and later' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'gRPC connection in AEDT 2022 R2 and later' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/ClientServer.rst", "range": {"start": {"line": 10, "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 100 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#L100 

[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": 100, "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"}

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"}
View more details on GitHub Actions