Skip to content

Commit

Permalink
Docstring updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jmwright committed Nov 7, 2024
1 parent 1e71230 commit 2aab495
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions nimble_build_system/cad/renderer.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2aab495

Please sign in to comment.