From 0c93a73e6a5a7e9fba863ce67a4aee77b2932875 Mon Sep 17 00:00:00 2001 From: JackB-Ansys Date: Fri, 13 Dec 2024 09:39:28 +0000 Subject: [PATCH] Updated Docstrings to avoid confusion --- src/ansys/motorcad/core/methods/rpc_methods_ui.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/ansys/motorcad/core/methods/rpc_methods_ui.py b/src/ansys/motorcad/core/methods/rpc_methods_ui.py index 835bb65b7..8dc53abd7 100644 --- a/src/ansys/motorcad/core/methods/rpc_methods_ui.py +++ b/src/ansys/motorcad/core/methods/rpc_methods_ui.py @@ -54,7 +54,7 @@ def initialise_tab_names(self): def save_motorcad_screen_to_file(self, screen_name, file_name): """Save the entire Motor-CAD screen of a tab to an image file. - Call the ``initialise_tab_names`` method before called this method.l The + Call the ``initialise_tab_names`` method before called this method. The Motor-CAD UI must be visible. Parameters @@ -127,19 +127,24 @@ def display_screen(self, screen_name): Parameters ---------- screen_name : str - Name of the screen. + Path of the screen to display. The path must be in this format: + ``"tabName;tabName;tabName"``. For example, + ``"Geometry;Axial"``. """ method = "DisplayScreen" params = [screen_name] return self.connection.send_and_receive(method, params) def save_screen_to_file(self, screen_name, file_name): - """Save a screen to an image file. + """Save the image from a Motor-CAD tab to an image file. + + This method is only available for select tabs (such as Geometry Radial and Axial tabs). Parameters ---------- screen_name : str - Name of the screen. + Name of the screen with the image to save. The name must be in this format: + ``"tabName"``. For example, ``"Axial"``. file_name : string or pathlib.Path Full path for the image file, including the file name and file extension. The extensions supported are BMP, JPG, and PNG.