Skip to content

Commit 789ab6c

Browse files
committed
Fix calc method signature
1 parent b36e03c commit 789ab6c

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

cdlclient/baseproxy.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -414,16 +414,15 @@ def import_macro_from_file(self, filename: str) -> None:
414414
"""
415415

416416
@abc.abstractmethod
417-
def calc(self, name: str, param: gds.DataSet | None = None) -> gds.DataSet:
417+
def calc(self, name: str, param: gds.DataSet | None = None) -> None:
418418
"""Call compute function ``name`` in current panel's processor.
419419
420420
Args:
421-
name (str): Compute function name
422-
param (guidata.dataset.DataSet | None): Compute function
423-
parameter. Defaults to None.
421+
name: Compute function name
422+
param: Compute function parameter. Defaults to None.
424423
425-
Returns:
426-
guidata.dataset.DataSet: Compute function result
424+
Raises:
425+
ValueError: unknown function
427426
"""
428427

429428
def __getattr__(self, name: str) -> Callable:

cdlclient/remote.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -430,16 +430,15 @@ def add_image(
430430
title, zbinary, xunit, yunit, zunit, xlabel, ylabel, zlabel
431431
)
432432

433-
def calc(self, name: str, param: gds.DataSet | None = None) -> gds.DataSet:
433+
def calc(self, name: str, param: gds.DataSet | None = None) -> None:
434434
"""Call compute function ``name`` in current panel's processor.
435435
436436
Args:
437-
name (str): Compute function name
438-
param (guidata.dataset.DataSet | None): Compute function
439-
parameter. Defaults to None.
437+
name: Compute function name
438+
param: Compute function parameter. Defaults to None.
440439
441-
Returns:
442-
guidata.dataset.DataSet: Compute function result
440+
Raises:
441+
ValueError: unknown function
443442
"""
444443
if param is None:
445444
return self._cdl.calc(name)

0 commit comments

Comments
 (0)