Skip to content

Commit

Permalink
fix(pylint): correct method description (#382)
Browse files Browse the repository at this point in the history
Update PyViCareHeatPump.py
  • Loading branch information
CFenner authored Sep 6, 2024
1 parent 4e3bbdc commit d55e15c
Showing 1 changed file with 23 additions and 23 deletions.
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 getAvailableVentilationModes(self):
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,19 +137,19 @@ def getAvailableVentilationPrograms(self):
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
Expand Down

0 comments on commit d55e15c

Please sign in to comment.