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.

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

merged 13 commits into from
Dec 4, 2024

Conversation

ansjmoody
Copy link
Collaborator

@ansjmoody ansjmoody commented Nov 21, 2024

Description

Please provide a brief description of the changes made in this pull request.
Add type hints to all source code. Update parameter types in comments to match.
Consistent formatting for commented parameter descriptions.
Updated rst files to include more classes.
Added SherlockNoGrpcConnectionException and raise this exception when there is no GRPC connection.
Fix and reduce warnings.
Fix bug when setting enum values in Analysis.update_pcb_modeling_props().
Use type constants instead of strings in examples and unit tests.
Removed "List of" in the parameter documentation description for collections. Sometimes the type isn't a list so this wording can be confusing.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.

Checklist:

  • Run unit tests and make sure they all pass
    - Run tests without Sherlock running
    - Run tests with Sherlock GRPC connection
  • Check and fix style errors
    - pre-commit command line check
    - Problems tab in PyCharm
  • [ran unit tests since parameters were not changed] Bench test new/modified APIs by using and modifying the code in the example for the API method
  • Add new classes to rst files, located at: \doc\source\api
  • Generate documentation
  • [I spot checked this] Verify the HTML. It gets generated at: \doc\build\html.
    - Open index.html
    - Click on "API Reference" at the top.
    - Verify HTML for API changes.
  • Check that test code coverage is at least 80% when Sherlock is running
  • Make sure that the title of the pull request follows Commit naming conventions (e.g. feat: adding new PySherlock command)

@github-actions github-actions bot added testing Anything related to tests documentation Improvements or additions to documentation labels Nov 21, 2024
@ansjmoody ansjmoody added this to the v0.8.0 milestone Nov 21, 2024
@ansjmoody ansjmoody linked an issue Nov 21, 2024 that may be closed by this pull request
@ansjmoody ansjmoody marked this pull request as ready for review November 22, 2024 21:36
@ansjmoody ansjmoody enabled auto-merge (squash) November 22, 2024 21:50
@github-actions github-actions bot added the dependencies Related with project dependencies label Dec 2, 2024
@github-actions github-actions bot added the maintenance Package and maintenance related label Dec 2, 2024
src/ansys/sherlock/core/common.py Outdated Show resolved Hide resolved
src/ansys/sherlock/core/layer.py Show resolved Hide resolved
src/ansys/sherlock/core/launcher.py Show resolved Hide resolved
src/ansys/sherlock/core/launcher.py Show resolved Hide resolved
src/ansys/sherlock/core/layer.py Outdated Show resolved Hide resolved
src/ansys/sherlock/core/layer.py Outdated Show resolved Hide resolved
src/ansys/sherlock/core/layer.py Outdated Show resolved Hide resolved
@ansjmoody ansjmoody merged commit df5a1de into main Dec 4, 2024
21 of 26 checks passed
@ansjmoody ansjmoody deleted the add_type_hints branch December 4, 2024 06:44
@RobPasMue RobPasMue mentioned this pull request Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related testing Anything related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Type Hints
4 participants