Skip to content

Commit

Permalink
Merged from main and improved Docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
JackB-Ansys committed May 7, 2024
1 parent 5473551 commit b611867
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions src/ansys/motorcad/core/rpc_client_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,13 @@ def is_running_in_internal_scripting():


def set_server_ip(ip):
"""IP address of the machine that Motor-CAD is running on."""
"""Set the IP address of the machine that Motor-CAD is running on.
Parameters
----------
ip : str
IP address of the machine that Motor-CAD is running on.
"""
global SERVER_IP
SERVER_IP = ip

Expand All @@ -53,13 +59,24 @@ def set_default_instance(port):
"""Set the Motor-CAD instance to use as the default when running scripts from MotorCAD.
For Motor-CAD internal use only. Do not use this function.
Parameters
----------
port : int
Port number of the Motor-CAD instance to be set as default.
"""
global DEFAULT_INSTANCE
DEFAULT_INSTANCE = port


def set_motorcad_exe(exe_location):
"""Set the directory with the Motor-CAD executable file to launch."""
"""Set the directory with the Motor-CAD executable file to launch.
Parameters
----------
exe_location : str
Directory of the Motor-CAD executable file to launch.
"""
global MOTORCAD_EXE_GLOBAL
MOTORCAD_EXE_GLOBAL = exe_location

Expand Down

0 comments on commit b611867

Please sign in to comment.