From 2aab495b5cb3b057a8ffea94b6b68f9d6739f586 Mon Sep 17 00:00:00 2001 From: Jeremy Wright Date: Thu, 7 Nov 2024 12:15:54 -0500 Subject: [PATCH] Docstring updates --- nimble_build_system/cad/renderer.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/nimble_build_system/cad/renderer.py b/nimble_build_system/cad/renderer.py index f808170..a69ebfe 100644 --- a/nimble_build_system/cad/renderer.py +++ b/nimble_build_system/cad/renderer.py @@ -10,17 +10,16 @@ def generate_render(model=None, image_format="png", file_path=None, render_optio Generates a render of an assembly. parameters: - model (cadquery): The model to render, can be either a single part or an assembly - camera_pos (tuple): The position of the camera when capturing the render - annotate (bool): Whether or not to annotate the render using cq-annotate + model (cadquery.Assembly): The assembly to render image_format (str): The format of the image to render (png, svg, gltf, etc) + file_path (str): The path to save the rendered image to + render_options (dict): A dictionary of options to pass to the render function for + things like which view to render,etc returns: - render_path (str): The path to the rendered image + None """ - # TODO - Return a bitmap buffer instead of a file path - # Check to see if we are dealing with a single part or an assembly if isinstance(model, cq.Assembly): # Handle assembly annotation