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

feat: add type hints #454

Merged
merged 13 commits into from
Dec 4, 2024
Merged

feat: add type hints #454

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8bdde06
feat: add type hints
ansjmoody Nov 12, 2024
f239cba
Fix warnings and issue in generating HTML
ansjmoody Nov 15, 2024
c04ac17
Model.createExportTraceCopperLayerParams()- changed to not allow str …
ansjmoody Nov 15, 2024
70db32c
Analysis.update_pcb_modeling_props()- fix bug when setting enum value…
ansjmoody Nov 19, 2024
c725e42
Add/modify type hints, fix/reduce warnings, change some methods to st…
ansjmoody Nov 21, 2024
89dc207
Changes from self review
ansjmoody Nov 21, 2024
dcc118b
chore: adding changelog file 454.documentation.md [dependabot-skip]
pyansys-ci-bot Nov 21, 2024
1966ef2
Changes from self review
ansjmoody Nov 21, 2024
7ec6591
More changes from self review, including moving project_types.ImageFi…
ansjmoody Nov 22, 2024
06aae06
pyproject.toml - change dependency for grpcio
ansjmoody Dec 2, 2024
7deb278
project_types.py: use forward declarations for type hints in the Imag…
ansjmoody Dec 2, 2024
5a4080c
Remove Optional from type hints where the default parameter value is …
ansjmoody Dec 2, 2024
f8a0da7
Change doc/Makefile to try to correct issues generating HTML by Git t…
ansjmoody Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions doc/source/api/analysis_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. _ref_analysis_types:

Analysis Types
==============
.. automodule:: ansys.sherlock.core.types.analysis_types
.. currentmodule:: ansys.sherlock.core.types.analysis_types

Constants
---------
.. autoclass:: ElementOrder
:members:
.. autoclass:: ModelSource
:members:
.. autoclass:: RunAnalysisRequestAnalysisType
:members:
.. autoclass:: RunStrainMapAnalysisRequestAnalysisType
:members:
.. autoclass:: UpdatePcbModelingPropsRequestAnalysisType
:members:
.. autoclass:: UpdatePcbModelingPropsRequestPcbMaterialModel
:members:
.. autoclass:: UpdatePcbModelingPropsRequestPcbModelType
:members:
2 changes: 2 additions & 0 deletions doc/source/api/common_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ Constants
:members:
.. autoclass:: TableDelimiter
:members:
.. autoclass:: Measurement
:members:
7 changes: 5 additions & 2 deletions doc/source/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ Use the search feature or click links to view API documentation.
:hidden:

analysis
analysis_types
common
common_types
launcher
layer
layer_types
lifecycle
model
parts
layer_types
parts_types
project
project_types
Expand All @@ -27,13 +28,15 @@ Use the search feature or click links to view API documentation.
.. autosummary::

ansys.sherlock.core.analysis
ansys.sherlock.core.types.analysis_types
ansys.sherlock.core.common
ansys.sherlock.core.types.common_types
ansys.sherlock.core.launcher
ansys.sherlock.core.layer
ansys.sherlock.core.types.layer_types
ansys.sherlock.core.lifecycle
ansys.sherlock.core.model
ansys.sherlock.core.parts
ansys.sherlock.core.types.layer_types
ansys.sherlock.core.types.parts_types
ansys.sherlock.core.project
ansys.sherlock.core.types.project_types
Expand Down
Loading
Loading