Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is this comment spurious #187

Open
timcoote opened this issue Sep 12, 2019 · 1 comment
Open

Is this comment spurious #187

timcoote opened this issue Sep 12, 2019 · 1 comment

Comments

@timcoote
Copy link

In the file src-api/openzwave/command.py, the class ZWaveNodeBasic(ZWaveNodeInterface), has this stanza at the beginning of a method:
"""
def get_power_level(self, value_id=None):
"""
The power level of this node.
The command 0x73 (COMMAND_CLASS_POWERLEVEL) of this node.
:param value_id: The value to retrieve state. If None, retrieve the first value
:type value_id: int
:return: The level of this battery
:rtype: int
"""
"""

Surely this command is to do with radio signal power and nothing to do with battery? If so, then the comment is misleading.

@kdschlosser
Copy link
Contributor

It is a mistake in the docstring. we are in the process of updating the library and this will be corrected. TY for pointing it out to us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants