doc : docstrings updated

Author: sepandhaghighi

orangetool/orangetool_display.py

@@ -53,10 +53,10 @@ def hdmi_size(v=None, h=None, debug=False):
     Change hdmi display resolution (need sudo -s) (if call without any argument return current resolution).
 
     :param v: vertical line
+    :type v : int
     :param h: horizontal line
+    :type h: int
     :param debug: flag for using debug mode
-    :type v : int
-    :type h:int
     :type debug:bool
     :return: bool
     """

orangetool/orangetool_ip.py

@@ -14,10 +14,10 @@ def internet(host="8.8.8.8", port=53, timeout=3):
     Check internet connections.
 
     :param  host: the host that check connection to
-    :param  port: port that check connection with
-    :param  timeout: times that check the connection
     :type host:str
+    :param  port: port that check connection with
     :type port:int
+    :param  timeout: times that check the connection
     :type timeout:int
     :return bool: True if Connection is Stable
     >>> internet() # if there is stable internet connection
@@ -89,12 +89,12 @@ def set_ip(ip, restart=False, device="eth0", debug=False):
     """
     Set static ip in interfaces file (need sudo).
 
+    :param ip: static ip
+    :type ip :str
     :param restart : restart flag
     :type restart : bool
     :param device: network device name
     :type device:str
-    :param ip: static ip
-    :type ip :str
     :param debug: flag for using debug mode
     :type debug:bool
     :return: True in successful
@@ -133,10 +133,10 @@ def ping(ip, packet_number=3, debug=False):
     Ping ip and return True if this ip is available and False otherwise.
 
     :param ip: target ip
-    :param packet_number: number of packet to size
-    :param debug: flag for using debug mode
     :type ip :str
+    :param packet_number: number of packet to size
     :type packet_number:int
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: a boolean value (True if ip is available and False otherwise)
     """

orangetool/orangetool_ram.py

@@ -69,7 +69,7 @@ def ram_percent():
     """
     Return available ram percentage.
 
-    :return: availabe ram percentage as string with %
+    :return: available ram percentage as string with %
     """
     response = list(psutil.virtual_memory())
     return str(response[2]) + " %"
@@ -81,7 +81,7 @@ def freeup(debug=False):
 
     :param debug: flag for using debug mode
     :type debug:bool
-    :return: Amount of freeuped ram as string and converted by convert_bytes()
+    :return: amount of freeuped ram as string and converted by convert_bytes()
     """
     try:
         RAM_before = int(ram_free(convert=False))

orangetool/orangetool_storage.py

@@ -10,6 +10,8 @@ def mount_status(device_name, debug=False):
     """
     Return addresses of mounted memory devices in dev by device name.
 
+    :param device_name: name of device
+    :type device_name: str
     :param debug: flag for using debug mode
     :type debug:bool
     :return: list of memory devices
@@ -124,10 +126,10 @@ def mount(device_name, mount_address=None, debug=False):
     Mount memory devices by addresses.
 
     :param device_name: name of device for mounted example = sda1
-    :param mount_address: address for mounting device example = /mnt/usb , default value is None in this case function generate random number for mount folder name
-    :param debug: flag for using debug mode
     :type device_name:str
+    :param mount_address: address for mounting device example = /mnt/usb , default value is None in this case function generate random number for mount folder name
     :type mount_address:str
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: True if device mount correctly and False other wise
     """

orangetool/orangetool_system.py

@@ -32,10 +32,10 @@ def get_temp(zone=0, debug=False):
     """
     Read cpu temperature.
 
-    :param debug : flag for using debug mode
     :param zone : thermal zone index
-    :type debug:bool
     :type zone:int
+    :param debug : flag for using debug mode
+    :type debug:bool
     :return: board temp as string in celsius
     """
     try:
@@ -137,12 +137,12 @@ def wakeup(day=0, hour=0, minute=0, debug=False):
     Set wakeup time for kernel RTC (need sudo).
 
     :param day: days for wakeup
-    :param hour: hout for wakeup
-    :param minute: minute for wakeup
-    :param debug: flag for using debug mode
     :type day:int
+    :param hour: hour for wakeup
     :type hour:int
+    :param minute: minute for wakeup
     :type minute:int
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: bool
     """