Skip to content

Commit 491a691

Browse files
authored
fix(pcan): swap SetValue and GetErrorText docstrings (#2058)
* fix(pcan): swap SetValue and GetErrorText docstrings The docstrings for SetValue and GetErrorText in pcan/basic.py were swapped: SetValue described returning an error text and GetErrorText described configuring a channel value. Swap them so each docstring matches its function. Fixes #2047 * ci: retrigger flaky test_send_periodic_duration Signed-off-by: Sai Asish Y <say.apm35@gmail.com> --------- Signed-off-by: Sai Asish Y <say.apm35@gmail.com>
1 parent 5d5cc16 commit 491a691

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

can/interfaces/pcan/basic.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -990,12 +990,10 @@ def GetValue(self, Channel, Parameter):
990990
logger.error("Exception on PCANBasic.GetValue")
991991
raise
992992

993-
# Returns a descriptive text of a given TPCANStatus
994-
# error code, in any desired language
993+
# Configures or sets a PCAN Channel value
995994
#
996995
def SetValue(self, Channel, Parameter, Buffer):
997-
"""Returns a descriptive text of a given TPCANStatus error
998-
code, in any desired language
996+
"""Configures or sets a PCAN Channel value
999997
1000998
Remarks:
1001999
Parameters can be present or not according with the kind
@@ -1036,7 +1034,8 @@ def SetValue(self, Channel, Parameter, Buffer):
10361034
raise
10371035

10381036
def GetErrorText(self, Error, Language=0):
1039-
"""Configures or sets a PCAN Channel value
1037+
"""Returns a descriptive text of a given TPCANStatus error
1038+
code, in any desired language
10401039
10411040
Remarks:
10421041

0 commit comments

Comments
 (0)