jan/masque
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[Tool / AutoTool] clarify some docstings

Browse Source
This commit is contained in:
Jan Petykiewicz 2025-11-16 22:58:02 -08:00
parent fe49e1e25b
commit 7389be9129
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
masque/builder/tools.py
View File

@ -135,7 +135,7 @@ class Tool:
kwargs: Custom tool-specific parameters. kwargs: Custom tool-specific parameters.
Returns: Returns:
The calculated output `Port` for the wire. The calculated output `Port` for the wire, assuming an input port at (0, 0) with rotation 0.
Any tool-specifc data, to be stored in `RenderStep.data`, for use during rendering. Any tool-specifc data, to be stored in `RenderStep.data`, for use during rendering.
Raises: Raises:
@ -173,7 +173,7 @@ class Tool:
kwargs: Custom tool-specific parameters. kwargs: Custom tool-specific parameters.
Returns: Returns:
The calculated output `Port` for the wire. The calculated output `Port` for the wire, assuming an input port at (0, 0) with rotation 0.
Any tool-specifc data, to be stored in `RenderStep.data`, for use during rendering. Any tool-specifc data, to be stored in `RenderStep.data`, for use during rendering.
Raises: Raises:
@ -211,7 +211,7 @@ class Tool:
kwargs: Custom tool-specific parameters. kwargs: Custom tool-specific parameters.
Returns: Returns:
The calculated output `Port` for the wire. The calculated output `Port` for the wire, assuming an input port at (0, 0) with rotation 0.
Any tool-specifc data, to be stored in `RenderStep.data`, for use during rendering. Any tool-specifc data, to be stored in `RenderStep.data`, for use during rendering.
Raises: Raises:
@ -382,6 +382,7 @@ class SimpleTool(Tool, metaclass=ABCMeta):
self._renderL(data=step.data, tree=tree, port_names=port_names, straight_kwargs=kwargs) self._renderL(data=step.data, tree=tree, port_names=port_names, straight_kwargs=kwargs)
return tree return tree
@dataclass @dataclass
class AutoTool(Tool, metaclass=ABCMeta): class AutoTool(Tool, metaclass=ABCMeta):
""" """
@ -407,7 +408,7 @@ class AutoTool(Tool, metaclass=ABCMeta):
fn: Callable[[float], Pattern] | Callable[[float], Library] fn: Callable[[float], Pattern] | Callable[[float], Library]
""" """
Generator function. `jog` (only argument) is assumed to be left (ccw) relative to travel Generator function. `jog` (only argument) is assumed to be left (ccw) relative to travel
and may be negative for a jog i the opposite direction. Won't be called if jog=0. and may be negative for a jog in the opposite direction. Won't be called if jog=0.
""" """
in_port_name: str in_port_name: str