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

docs: Updated documentation in update potting region. #477

Merged
merged 4 commits into from
Jan 15, 2025
Merged

docs: Updated documentation in update potting region. #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f8fecd4
Updated documentation in update potting region.
anskhanson Dec 20, 2024
82183d9
PR Feedback: Indented line and renamed request.
anskhanson Jan 15, 2025
22d0a0a
chore: adding changelog file 477.miscellaneous.md [dependabot-skip]
pyansys-ci-bot Jan 15, 2025
828acc7
chore: adding changelog file 477.documentation.md [dependabot-skip]
pyansys-ci-bot Jan 15, 2025
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
1 change: 1 addition & 0 deletions doc/changelog.d/477.documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs: Updated documentation in update potting region.
17 changes: 10 additions & 7 deletions src/ansys/sherlock/core/layer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ def update_potting_region(
>>> from ansys.sherlock.core.types.layer_types import PottingRegion
>>> sherlock = launch_sherlock()
>>>
>>> update_request1 = PottingRegionUpdateData(
>>> update1 = PottingRegionUpdateData(
potting_region_id_to_update=potting_id,
potting_region=PottingRegionData(
cca_name=cca_name,
Expand All @@ -298,7 +298,7 @@ def update_potting_region(
)
)
)
>>> update_request2 = PottingRegionUpdateData(
>>> update2 = PottingRegionUpdateData(
potting_region_id_to_update=potting_id,
potting_region=PottingRegionData(
cca_name=cca_name,
Expand All @@ -314,11 +314,14 @@ def update_potting_region(
)
)
)
>>> potting_region_requests = [
update_request1,
update_request2
]
>>> return_codes = sherlock.layer.update_potting_region(request)
>>> example_request = UpdatePottingRegionRequest(
"project_name",
[
update1,
update2
]
)
anskhanson marked this conversation as resolved.
Show resolved Hide resolved
>>> return_codes = sherlock.layer.update_potting_region(example_request)
"""
update_request = request._convert_to_grpc()

Expand Down
Loading