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

fix(pylint): correct method description #382

Merged
merged 1 commit into from
Sep 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions PyViCare/PyViCareHeatPump.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,18 +109,18 @@
def getActiveVentilationMode(self):
return self.service.getProperty("ventilation.operating.modes.active")["properties"]["value"]["value"]

""" Set the active mode
Parameters
----------
mode : str
Valid mode can be obtained using getModes()

Returns
-------
result: json
json representation of the answer
"""
def setActiveVentilationMode(self, mode):
""" Set the active mode
Parameters
----------
mode : str
Valid mode can be obtained using getModes()

Check warning on line 118 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.6)

W293 blank line contains whitespace

Check warning on line 118 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.8)

W293 blank line contains whitespace

Check warning on line 118 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.9)

W293 blank line contains whitespace
Returns
-------
result: json
json representation of the answer
"""
return self.service.setProperty("ventilation.operating.modes.active", "setMode", {'mode': mode})

@handleNotSupported
Expand All @@ -137,22 +137,22 @@
def getActiveVentilationProgram(self):
return self.service.getProperty("ventilation.operating.programs.active")["properties"]["value"]["value"]

""" Activate a ventilation program
NOTE
DEVICE_COMMUNICATION_ERROR can just mean that the program is already on
Parameters
----------
program : str

Returns
-------
result: json
json representation of the answer
"""
def activateVentilationProgram(self, program):
""" Activate a ventilation program
NOTE
DEVICE_COMMUNICATION_ERROR can just mean that the program is already on
Parameters
----------
program : str

Check warning on line 147 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.6)

W293 blank line contains whitespace

Check warning on line 147 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.8)

W293 blank line contains whitespace

Check warning on line 147 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.9)

W293 blank line contains whitespace
Returns
-------
result: json
json representation of the answer
"""
return self.service.setProperty(f"ventilation.operating.programs.{program}", "activate", {})

class Compressor(HeatingDeviceWithComponent):

Check failure on line 155 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.6)

E302 expected 2 blank lines, found 1

Check failure on line 155 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.8)

E302 expected 2 blank lines, found 1

Check failure on line 155 in PyViCare/PyViCareHeatPump.py

View workflow job for this annotation

GitHub Actions / build (3.9)

E302 expected 2 blank lines, found 1

@property
def compressor(self) -> str:
Expand Down
Loading