fix(pcan): swap SetValue and GetErrorText docstrings#2058
Open
SAY-5 wants to merge 1 commit into
Open
Conversation
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 hardbyte#2047
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2047.
In
can/interfaces/pcan/basic.py, the docstrings (and the preceding# Returns a descriptive text...C-style comment) onSetValueandGetErrorTextwere swapped:SetValue(line 996) described "Returns a descriptive text of a given TPCANStatus error code".GetErrorText(line 1038) described "Configures or sets a PCAN Channel value".Both functions' implementations are correct; only the docstrings disagreed with the code. This swap restores each docstring to its matching function, so
help(PCANBasic.SetValue)andhelp(PCANBasic.GetErrorText)describe what they actually do.Verified locally:
python -c "from can.interfaces.pcan.basic import PCANBasic; help(PCANBasic.SetValue)"now reports "Configures or sets a PCAN Channel value".