doc : docstrings updated

Author: sepandhaghighi

orangetool/orangetool_display.py

@@ -8,7 +8,7 @@ def hdmi_controller(command, debug=False):
 
     :param command: inpurt command
     :type command: bool
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug: bool
     :return: bool
     """
@@ -30,7 +30,7 @@ def hdmi_on(debug=False):
     """
     Turn on hdmi port (need sudo -s).
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: bool
     """
@@ -41,7 +41,7 @@ def hdmi_off(debug=False):
     """
     Turn off hdmi port (need sudo -s).
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: bool
     """
@@ -54,7 +54,7 @@ def hdmi_size(v=None, h=None, debug=False):
 
     :param v: vertical line
     :param h: horizental line
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type v : int
     :type h:int
     :type debug:bool

orangetool/orangetool_ip.py

@@ -40,7 +40,7 @@ def local_ip(debug=False):
     """
     Return local ip of computer in windows by socket module and in unix with hostname command in shell.
 
-    :param debug:flag for using Debug Mode
+    :param debug:flag for using debug Mode
     :type debug:bool
     :return: local ip as string
     """
@@ -71,7 +71,7 @@ def global_ip(debug=False):
     """
     Return ip with by http://ipinfo.io/ip api.
 
-    :param debug:flag for using Debug mode
+    :param debug:flag for using debug mode
     :type debug:bool
     :return: global ip as string
     """
@@ -97,7 +97,7 @@ def set_ip(ip, restart=False, device="eth0", debug=False):
     :type device:str
     :param ip: static ip
     :type ip :str
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: True in successful
     """
@@ -136,7 +136,7 @@ def ping(ip, packet_number=3, debug=False):
 
     :param ip: target ip
     :param packet_number: number of packet to size
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type ip :str
     :type packet_number:int
     :type debug:bool
@@ -164,7 +164,7 @@ def mac(debug=False):
     """
     Return mac addresses of net devices.
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: return mac addresses as dict with name as keys and mac addresses as values
     """

orangetool/orangetool_ram.py

@@ -79,7 +79,7 @@ def freeup(debug=False):
     """
     To free pagecache, dentries and inodes.
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: Amount of freeuped ram as string and converted by convert_bytes()
     """

orangetool/orangetool_storage.py

@@ -10,7 +10,7 @@ def mount_status(device_name, debug=False):
     """
     Return addresses of mounted memory devices in dev by device name.
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: list of memory devices
     """
@@ -36,7 +36,7 @@ def storage_status(debug=False):
     """
     Return all of the inserted memory and their status.
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: all of the inserted memory and their status as dictionary ( device name as keys and mount status (mounted_addresses as list and u --> unmounted) as values
     """
@@ -62,7 +62,7 @@ def unmount(ADDRESS, debug=False):
 
     :param ADDRESS: address of that device mount on
     :type ADDRESS:str
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: True if device unmount correctly and False other wise
     """
@@ -83,7 +83,7 @@ def unmount_all(debug=False):
     """
     Unmount all of the mounted devices.
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: return True if all of the mounted devices unmount correctly
     """
@@ -125,7 +125,7 @@ def mount(device_name, mount_address=None, debug=False):
 
     :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
+    :param debug: flag for using debug mode
     :type device_name:str
     :type mount_address:str
     :type debug:bool

orangetool/orangetool_system.py

@@ -14,7 +14,7 @@ def check_update(debug=False):
     """
     Check orangetool site for new version.
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: True if new version is available
     """
@@ -35,7 +35,7 @@ def get_temp(Zone=0, debug=False):
     """
     Read cpu temperature.
 
-    :param debug : flag for using Debug mode
+    :param debug : flag for using debug mode
     :param Zone : thermal Zone Index
     :type debug:bool
     :type Zone:int
@@ -93,7 +93,7 @@ def uptime(debug=False):
     """
     Return system uptime.
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: system uptime as string
     """
@@ -111,7 +111,7 @@ def idletime(debug=False):
     """
     Return system idletime.
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: system idle as string
     """
@@ -142,7 +142,7 @@ def wakeup(day=0, hour=0, minute=0, debug=False):
     :param day: days for wakeup
     :param hour: hout for wakeup
     :param minute: minute for wakeup
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type day:int
     :type hour:int
     :type minute:int
@@ -171,7 +171,7 @@ def power_control(command, debug=False):
 
     :param command: input command
     :type command: str
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug: bool
     :return: None
     """
@@ -194,7 +194,7 @@ def sleep(debug=False):
     """
     Shortcut for sleep command (need sudo).
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: None
     """
@@ -204,7 +204,7 @@ def hibernate(debug=False):
     """
     Shortcut for hibernate command (need sudo).
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: None
     """
@@ -215,7 +215,7 @@ def halt(debug=False):
     """
     Shortcut for poweroff (need sudo).
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: None
     """
@@ -226,7 +226,7 @@ def restart(debug=False):
     """
     Shortcut for reboot (need sudo).
 
-    :param debug: flag for using Debug mode
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: None
     """