From 3f9c9f81fe6b676e77ac1c496fa0c4368e8a535d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antonio=20Serrano=20Mu=C3=B1oz?= Date: Tue, 16 Aug 2022 11:49:11 +0200 Subject: [PATCH] Modify function docstring descriptions --- .../semu/misc/vscode/scripts/extension.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/exts/semu.misc.vscode/semu/misc/vscode/scripts/extension.py b/exts/semu.misc.vscode/semu/misc/vscode/scripts/extension.py index e8279cd..d35fda6 100644 --- a/exts/semu.misc.vscode/semu/misc/vscode/scripts/extension.py +++ b/exts/semu.misc.vscode/semu/misc/vscode/scripts/extension.py @@ -107,7 +107,7 @@ def _show_notification(self, *args, **kwargs) -> None: notification = "Unable to start the socket server at {}:{}".format(self._socket_ip, self._socket_port) status=omni.kit.notification_manager.NotificationStatus.WARNING else: - notification = "Socket server running at {}:{}".format(self._socket_ip, self._socket_port) + notification = "Embedded VS Code socket server is running at {}:{}".format(self._socket_ip, self._socket_port) status=omni.kit.notification_manager.NotificationStatus.INFO ok_button = omni.kit.notification_manager.NotificationButtonInfo("OK", on_complete=None) @@ -123,7 +123,7 @@ def _show_notification(self, *args, **kwargs) -> None: # internal socket methods def _create_socket(self) -> None: - """Create a socket server to listen for incoming connections from the IPython kernel + """Create a socket server to listen for incoming connections from the client """ class ServerProtocol(asyncio.Protocol): def __init__(self, parent) -> None: @@ -150,14 +150,14 @@ async def server_task(): task = _get_event_loop().create_task(server_task()) async def _exec_code_async(self, statement: str, transport: asyncio.Transport) -> None: - """Execute the statement in the Omniverse scope and send the result to the IPython kernel + """Execute the statement in the Omniverse scope and send the result to the client :param statement: statement to execute :type statement: str - :param transport: transport to send the result to the IPython kernel + :param transport: transport to send the result to the client :type transport: asyncio.Transport - :return: reply dictionary as ipython notebook expects it + :return: reply dictionary as expected by the client :rtype: dict """ _stdout = StringIO() @@ -197,7 +197,7 @@ async def _exec_code_async(self, statement: str, transport: asyncio.Transport) - # add output to reply dictionary for printing reply["output"] = _stdout.getvalue() - # send the reply to the IPython kernel + # send the reply to the client reply = json.dumps(reply) transport.write(reply.encode())