Add links to the commands used by 'get_properties'

JeffLIrion · Sep 6, 2019 · 2239b75 · 2239b75
1 parent cc4274a
commit 2239b75
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/androidtv/firetv.py b/androidtv/firetv.py
@@ -280,6 +280,13 @@ def stop_app(self, app):
     def get_properties(self, get_running_apps=True, lazy=False):
         """Get the properties needed for Home Assistant updates.
 
+        This will send one of the following ADB commands:
+
+        * :py:const:`androidtv.constants.CMD_FIRETV_PROPERTIES_LAZY_RUNNING_APPS`
+        * :py:const:`androidtv.constants.CMD_FIRETV_PROPERTIES_LAZY_NO_RUNNING_APPS`
+        * :py:const:`androidtv.constants.CMD_FIRETV_PROPERTIES_NOT_LAZY_RUNNING_APPS`
+        * :py:const:`androidtv.constants.CMD_FIRETV_PROPERTIES_NOT_LAZY_NO_RUNNING_APPS`
+
         Parameters
         ----------
         get_running_apps : bool