diff --git a/doc/changelog.d/477.documentation.md b/doc/changelog.d/477.documentation.md new file mode 100644 index 000000000..0ed8b1b86 --- /dev/null +++ b/doc/changelog.d/477.documentation.md @@ -0,0 +1 @@ +docs: Updated documentation in update potting region. \ No newline at end of file diff --git a/src/ansys/sherlock/core/layer.py b/src/ansys/sherlock/core/layer.py index b47ca971d..0900ad862 100644 --- a/src/ansys/sherlock/core/layer.py +++ b/src/ansys/sherlock/core/layer.py @@ -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, @@ -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, @@ -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 + ] + ) + >>> return_codes = sherlock.layer.update_potting_region(example_request) """ update_request = request._convert_to_grpc()