Skip to content

Commit

Permalink
Updated Docstrings to avoid confusion
Browse files Browse the repository at this point in the history
  • Loading branch information
JackB-Ansys committed Dec 13, 2024
1 parent 69475d2 commit 0c93a73
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions src/ansys/motorcad/core/methods/rpc_methods_ui.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 0c93a73

Please sign in to comment.