Skip to content

Commit 55d28d4

Browse files
committed
Enhance compute_* methods func argument docstring for clarity
1 parent b2405b1 commit 55d28d4

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

cdl/core/gui/processor/base.py

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,10 @@ def compute_1_to_1(
451451
The result of each computation is a new object appended to the same panel.
452452
453453
Args:
454-
func: Function to execute.
454+
func: Function to execute, that takes either `(dst_obj, src_obj)` or
455+
`(dst_obj, src_obj, param)` as arguments, where `dst_obj` is the output
456+
object, `src_obj` is the input object, and `param` is an optional
457+
parameter set.
455458
param: Optional parameter instance.
456459
paramclass: Optional parameter class for editing.
457460
title: Optional progress bar title.
@@ -484,7 +487,10 @@ def compute_1_to_n(
484487
outputs per object. The resulting objects are appended to the active panel.
485488
486489
Args:
487-
funcs: Single function or list of functions to apply.
490+
funcs: Single function or list of functions to apply. Each function takes
491+
either `(dst_obj, src_obj)` or `(dst_obj, src_obj, param)` as arguments,
492+
where `dst_obj` is the output object, `src_obj` is the input object,
493+
and `param` is an optional parameter set.
488494
params: List of parameter instances corresponding to each function.
489495
title: Optional progress bar title.
490496
edit: Whether to open the parameter editor before execution.
@@ -526,7 +532,9 @@ def compute_1_to_0(
526532
dictionary.
527533
528534
Args:
529-
func: Function to execute.
535+
func: Function to execute, that takes either `(obj)` or `(obj, param)` as
536+
arguments, where `obj` is the input object and `param` is an optional
537+
parameter set.
530538
param: Optional parameter instance.
531539
paramclass: Optional parameter class for editing.
532540
title: Optional progress bar title.
@@ -622,7 +630,10 @@ def compute_n_to_1(
622630
623631
Args:
624632
name: Operation name (used for object titles).
625-
func: Function to apply to object(s).
633+
func: Function to apply, that takes either `(dst_obj, src_obj)` or
634+
`(dst_obj, src_obj, param)` as arguments, where `dst_obj` is the output
635+
object, `src_obj` is the input object, and `param` is an optional
636+
parameter set.
626637
param: Optional parameter instance.
627638
paramclass: Optional parameter class for editing.
628639
title: Optional progress bar title.
@@ -795,7 +806,11 @@ def compute_2_to_1(
795806
Args:
796807
obj2: Second operand (single object or list for pairwise mode).
797808
obj2_name: Display name for the second operand (used in selection dialog).
798-
func: Function to apply.
809+
func: Function to apply, that takes either `(dst_obj, src_obj1, src_obj2)`
810+
or `(dst_obj, src_obj1, src_obj2, param)` as arguments, where
811+
`dst_obj` is the output object, `src_obj1` is the first input object,
812+
`src_obj2` is the second input object (operand), and `param` is an
813+
optional parameter set.
799814
param: Optional parameter instance.
800815
paramclass: Optional parameter class for editing.
801816
title: Optional progress bar title.

0 commit comments

Comments
 (0)