Merge pull request #376 from malverick/suppported_platforms

Add list of supported platforms to facade

plyer/facades/accelerometer.py

@@ -26,6 +26,10 @@
     >>> accelerometer.acceleration
     (-10.048464775085449, 6.825869083404541, 7.7260890007019043)
 
+Supported Plaforms
+------------------
+Android, iOS, OS X, Linux
+
 '''
 
 

plyer/facades/audio.py

@@ -39,6 +39,10 @@
 
     >>> audio.play()
 
+Supported Platforms
+-------------------
+Android
+
 '''
 
 

plyer/facades/barometer.py

@@ -9,6 +9,8 @@ class Barometer(object):
     Use property `pressure` to get current air pressure in hPa.
 
     .. versionadded:: 1.2.5
+
+    Supported Platforms:: Android
     '''
 
     @property

plyer/facades/battery.py

@@ -16,6 +16,10 @@
     >>> battery.status
     {'percentage': 82.0, 'isCharging': False}
 
+Supported Platforms
+-------------------
+Android, iOS, Windows, OS X, Linux
+
 '''
 
 

plyer/facades/brightness.py

@@ -21,6 +21,9 @@
     >>> from plyer import brightness
     >>> brightness.set_level(50)
 
+Supported Platforms
+-------------------
+Android, iOS, Linux
 '''
 
 

plyer/facades/call.py

@@ -23,6 +23,10 @@
 
     >>> call.dialcall()
 
+Supported Platforms
+-------------------
+Android, iOS
+
 '''
 
 

plyer/facades/camera.py

@@ -35,6 +35,10 @@
     >>> camera.take_video(filename=file_name,
     >>>                   on_complete=camera_callback)
 
+Supported Platforms
+-------------------
+Android, iOS
+
 '''
 
 

plyer/facades/compass.py

@@ -29,6 +29,11 @@
     # a,b,c denote the Geomagnetic field strength
     # (without hard iron calibration) along the three axes.
     # x,y,z denote the Iron bias estimation along the three axes.
+
+Supported Platforms
+-------------------
+Android, iOS
+
 '''
 
 

plyer/facades/email.py

@@ -23,6 +23,10 @@
 
     >>> # opens email interface where user can change the content.
 
+Supported Platforms
+-------------------
+Android, iOS, Windows, OS X, Linux
+
 '''
 
 

plyer/facades/filechooser.py

@@ -30,6 +30,10 @@
 
 Important: these methods will return only after user interaction.
 Use threads or you will stop the mainloop if your app has one.
+
+Supported Platforms
+-------------------
+Windows, OS X, Linux
 '''
 
 

plyer/facades/flash.py

@@ -31,6 +31,10 @@
 
     >>> flash.release()
 
+Supported Platforms
+-------------------
+Android, iOS
+
 '''
 
 

plyer/facades/gps.py

@@ -37,6 +37,11 @@ def print_locations(**kwargs):
     gps.start()
     # later
     gps.stop()
+
+Supported Platforms
+-------------------
+Android, iOS
+
 '''
 
 

plyer/facades/gravity.py

@@ -2,6 +2,9 @@ class Gravity(object):
     '''Gravity facade.
 
     .. versionadded:: 1.2.5
+
+    Supported Platforms:: Android
+
     '''
 
     @property

plyer/facades/gyroscope.py

@@ -33,6 +33,11 @@
     where the first three values show the rate of rotation w/o drift
     compensation and the last three show the estimated drift along the three
     axes.
+
+Supported Platforms
+-------------------
+Android, iOS
+
 '''
 
 

plyer/facades/irblaster.py

@@ -27,6 +27,10 @@
     >>> irblaster.exists()
     True/False
 
+Supported Platforms
+-------------------
+Android
+
 '''
 
 

plyer/facades/light.py

@@ -10,6 +10,8 @@ class Light(object):
     Use property `illumination` to get current illumination in lx.
 
     .. versionadded:: 1.2.5
+
+    Supported Platforms:: Android
     '''
 
     @property

plyer/facades/notification.py

@@ -15,6 +15,10 @@
     >>> message = 'This is an example.'
     >>> notification.notify(title=title, message=message)
 
+Supported Platforms
+-------------------
+Android, Windows, OS X, Linux
+
 '''
 
 

plyer/facades/orientation.py

@@ -28,6 +28,10 @@
 
     >>> orientation.set_sensor()
 
+Supported Platforms
+-------------------
+Android
+
 '''
 
 

plyer/facades/proximity.py

@@ -12,6 +12,8 @@ class Proximity(object):
     property `proximity`. It returns `True` when object is close.
 
     .. versionadded:: 1.2.5
+
+    Supported Platforms::Android
     '''
 
     @property

plyer/facades/sms.py

@@ -21,6 +21,10 @@
     >>> message = 'This is an example.'
     >>> sms.send(recipient=recipient, message=message)
 
+Supported Platforms
+-------------------
+Android, iOS
+
 '''
 
 

plyer/facades/spatialorientation.py

@@ -29,6 +29,8 @@ def orientation(self):
         The range of values is -π/2 to π/2.
 
         Returns (None, None, None) if no data is currently available.
+
+        Supported Platforms:: Android
         '''
         return self._get_orientation() or (None, None, None)
 

plyer/facades/temperature.py

@@ -11,6 +11,9 @@ class Temperature(object):
     Use property `temperature` to get ambient air temperature in degree C.
 
     .. versionadded:: 1.2.5
+
+    Supported Platforms:: Android
+
     '''
 
     @property

plyer/facades/tts.py

@@ -13,6 +13,10 @@
     >>> from plyer import tts
     >>> tts.speak(message=message)
 
+Supported Platforms
+-------------------
+Android, iOS, Windows, OS X, Linux
+
 '''
 
 

plyer/facades/uniqueid.py

@@ -21,6 +21,11 @@
 
 .. versionchanged:: 1.2.4
     On Android returns Android ID instead of IMEI.
+
+Supported Platforms
+-------------------
+Android, iOS, Windows, OS X, Linux
+
 '''
 
 

plyer/facades/vibrator.py

@@ -30,6 +30,11 @@
 
     >>> vibrator.cancel()
 
+Supported Platforms
+-------------------
+Android, iOS
+
+
 '''
 
 

plyer/facades/wifi.py

@@ -59,6 +59,11 @@
     >>> return wifi.get_available_wifi()
 
 This returns all the available wifi networks near the device.
+
+Supported Platforms
+-------------------
+Windows, OS X, Linux
+
 '''