diff --git a/pyproject.toml b/pyproject.toml index a85f135..fd32665 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "cwapi3d" -version = "32.443.3" +version = "32.443.4" authors = [{ name = "Cadwork", email = "it@cadwork.ca" }] requires-python = ">= 3.12" description = 'Python bindings for CwAPI3D' diff --git a/src/utility_controller/__init__.pyi b/src/utility_controller/__init__.pyi index a4edd95..e779f49 100644 --- a/src/utility_controller/__init__.pyi +++ b/src/utility_controller/__init__.pyi @@ -38,7 +38,11 @@ def set_project_data(project_data_id: str, data: str) -> None: def print_error(message: str) -> None: - """Prints an error. + """Prints an error to the bottom toolbar of Cadwork 3d. + + Notes: + Attention, this function is blocking. User will need to click to + continue the process. Parameters: message: The error message. @@ -54,7 +58,12 @@ def get_language() -> str: def print_message(message: str, row: int, column: int) -> None: - """Prints a message. + """Prints a message that will be visualized in the bottom toolbar of the + 3D view. You can arrange the message in the desired position by specifying the row and column. + + Examples: + >>> import utility_controller as uc + >>> uc.print_message("Hello World!", 1, 1) Parameters: message: The message to print. @@ -297,7 +306,7 @@ def create_new_guid() -> str: def print_to_console(message: str) -> None: - """Prints a message to the console. + """Prints a message to the Cadwork debug console. Parameters: message: The message.