autodoc: string -> str

Author: tony

bootstrap_env.py

@@ -34,7 +34,7 @@ def which(exe=None, throw=True):
     :type exe: string
     :param throw: Raise ``Exception`` if not found in paths
     :type throw: bool
-    :rtype: string
+    :rtype: str
 
     """
     if exe:
@@ -132,5 +132,6 @@ def main():
     if os.path.exists(os.path.join(env_dir, 'build')):
         os.removedirs(os.path.join(env_dir, 'build'))
 
+
 if __name__ == '__main__':
     main()

libtmux/common.py

@@ -42,10 +42,9 @@ def set_environment(self, name, value):
         """Set environment ``$ tmux set-environment <name> <value>``.
 
         :param name: the environment variable name. such as 'PATH'.
-        :type option: string
+        :type option: str
         :param value: environment value.
-        :type value: string
-
+        :type value: str
         """
 
         args = ['set-environment']
@@ -65,7 +64,7 @@ def unset_environment(self, name):
         """Unset environment variable ``$ tmux set-environment -u <name>``.
 
         :param name: the environment variable name. such as 'PATH'.
-        :type option: string
+        :type option: str
         """
 
         args = ['set-environment']
@@ -84,7 +83,7 @@ def remove_environment(self, name):
         """Remove environment variable ``$ tmux set-environment -r <name>``.
 
         :param name: the environment variable name. such as 'PATH'.
-        :type option: string
+        :type option: str
         """
 
         args = ['set-environment']
@@ -106,7 +105,7 @@ def show_environment(self, name=None):
         specific variable if the name is specified.
 
         :param name: the environment variable name. such as 'PATH'.
-        :type option: string
+        :type option: str
         """
         tmux_args = ['show-environment']
         if self._add_option:
@@ -341,7 +340,7 @@ def get_by_id(self, id):
         .. _.get(): http://backbonejs.org/#Collection-get
 
         :param id:
-        :type id: string
+        :type id: str
         :rtype: object
 
         """
@@ -362,12 +361,12 @@ def which(exe=None, default_paths=[
     from salt.util - https://www.github.com/saltstack/salt - license apache
 
     :param exe: Application to search PATHs for.
-    :type exe: string
+    :type exe: str
     :param default_path: Application to search PATHs for.
     :type default_path: list
     :param append_env_path: Append PATHs in environmental variables.
     :type append_env_path: bool
-    :rtype: string
+    :rtype: str
 
     """
     def _is_executable_file_or_link(exe):
@@ -440,7 +439,7 @@ def has_version(version):
     """Return True if tmux version installed.
 
     :param version: version, '1.8'
-    :type version: string
+    :type version: str
     :returns: True if version matches
     :rtype: bool
     """
@@ -451,7 +450,7 @@ def has_gt_version(min_version):
     """Return True if tmux version greater than minimum.
 
     :param min_version: version, e.g. '1.8'
-    :type min_version: string
+    :type min_version: str
     :returns: True if version above min_version
     :rtype: bool
     """
@@ -462,7 +461,7 @@ def has_gte_version(min_version):
     """Return True if tmux version greater or equal to minimum.
 
     :param min_version: version, e.g. '1.8'
-    :type min_version: string
+    :type min_version: str
     :returns: True if version above or equal to min_version
     :rtype: bool
     """
@@ -473,7 +472,7 @@ def has_lte_version(max_version):
     """Return True if tmux version less or equal to minimum.
 
     :param max_version: version, e.g. '1.8'
-    :type max_version: string
+    :type max_version: str
     :returns: True if version below or equal to max_version
     :rtype: bool
     """
@@ -484,7 +483,7 @@ def has_lt_version(max_version):
     """Return True if tmux version less than minimum.
 
     :param max_version: version, e.g. '1.8'
-    :type max_version: string
+    :type max_version: str
     :returns: True if version below max_version
     :rtype: bool
     """
@@ -527,7 +526,7 @@ def session_check_name(session_name):
     These delimiters are reserved for noting session, window and pane.
 
     :param session_name: name of session
-    :type session_name: string
+    :type session_name: str
     :returns: void
     :raises: :exc:`exc.BadSessionName`
     """

libtmux/pane.py

@@ -113,7 +113,7 @@ def split_window(self, attach=False, vertical=True, start_directory=None):
         :rtype: :class:`Pane`.
         :param start_directory: specifies the working directory in which the
             new pane is created.
-        :type start_directory: string
+        :type start_directory: str
 
         """
         return self.window.split_window(
@@ -145,7 +145,7 @@ def resize_pane(self, *args, **kwargs):
         """``$ tmux resize-pane`` of pane and return ``self``.
 
         :param target_pane: ``target_pane``, or ``-U``,``-D``, ``-L``, ``-R``.
-        :type target_pane: string
+        :type target_pane: str
         :rtype: :class:`Pane`
 
         """

libtmux/server.py

@@ -417,7 +417,7 @@ def new_session(self,
 
             $ tmux new-session -s <session_name>
 
-        :type session_name: string
+        :type session_name: str
 
         :param attach: create session in the foreground. ``attach=False`` is
             equivalent to::
@@ -432,7 +432,7 @@ def new_session(self,
 
         :param start_directory: specifies the working directory in which the
             new session is created.
-        :type start_directory: string
+        :type start_directory: str
 
         :raises: :exc:`exc.BadSessionName`
         :rtype: :class:`Session`

libtmux/session.py

@@ -106,7 +106,7 @@ def rename_session(self, new_name):
         """Rename session and return new :class:`Session` object.
 
         :param new_name: new session name
-        :type new_name: string
+        :type new_name: str
         :raises: :exc:`exc.BadSessionName`
         :rtype: :class:`Session`
 
@@ -136,22 +136,22 @@ def new_window(self,
         to be created and not set to current, pass in ``attach=False``.
 
         :param window_name: window name.
-        :type window_name: string
+        :type window_name: str
         :param start_directory: specifies the working directory in which the
             new window is created.
-        :type start_directory: string
+        :type start_directory: str
         :param attach: make new window the current window after creating it,
                        default True.
         :param window_index: create the new window at the given index position.
             Default is empty string which will create the window in the next
             available position.
-        :type window_index: string
+        :type window_index: str
         :param window_shell: execute a command on starting the window.  The
             window will close when the command exits.
             NOTE: When this command exits the window will close.  This feature
             is useful for long-running processes where the closing of the
             window upon completion is desired.
-        :type window_command: string
+        :type window_command: str
         :param type: bool
         :rtype: :class:`Window`
 
@@ -212,7 +212,7 @@ def kill_window(self, target_window=None):
         from any sessions to which it is linked.
 
         :param target_window: the ``target window``.
-        :type target_window: string
+        :type target_window: str
 
         """
 
@@ -322,7 +322,7 @@ def set_option(self, option, value, g=False):
         todo: needs tests
 
         :param option: the window option. such as 'default-shell'.
-        :type option: string
+        :type option: str
         :param value: window value. True/False will turn in 'on' and 'off'. You
             can also enter 'on' or 'off' directly.
         :type value: bool
@@ -359,7 +359,7 @@ def show_options(self, option=None, g=False):
         a single option, forwarding to :meth:`Session.show_option`.
 
         :param option: optional. show a single option.
-        :type option: string
+        :type option: str
         :param g: Pass ``-g`` flag for global variable (server-wide)
         :type g: bool
         :rtype: :py:obj:`dict`
@@ -395,10 +395,10 @@ def show_option(self, option, g=False):
         :todo: test and return True/False for on/off string
 
         :param option: option to return.
-        :type option: string
+        :type option: str
         :param global: check for option globally across all servers (-g)
         :type global: bool
-        :rtype: string, int or bool
+        :rtype: str, int or bool
         :raises: :exc:`exc.OptionError`, :exc:`exc.UnknownOption`,
             :exc:`exc.InvalidOption`, :exc:`exc.AmbiguousOption`
 

libtmux/window.py

@@ -115,7 +115,7 @@ def select_layout(self, layout=None):
         custom: custom dimensions (see :term:`tmux(1)` manpages).
 
         :param layout: string of the layout, 'even-horizontal', 'tiled', etc.
-        :type layout: string
+        :type layout: str
 
         """
 
@@ -164,7 +164,7 @@ def show_window_options(self, option=None, g=False):
         a single option, forwarding to :meth:`Window.show_window_option`.
 
         :param option: optional. show a single option.
-        :type option: string
+        :type option: str
         :param g: Pass ``-g`` flag for global variable
         :type g: bool
         :rtype: :py:obj:`dict`
@@ -203,10 +203,10 @@ def show_window_option(self, option, g=False):
         todo: test and return True/False for on/off string
 
         :param option: option to return.
-        :type option: string
+        :type option: str
         :param g: Pass ``-g`` flag, global.
         :type g: bool
-        :rtype: string, int
+        :rtype: str, int
         :raises: :exc:`exc.OptionError`, :exc:`exc.UnknownOption`,
             :exc:`exc.InvalidOption`, :exc:`exc.AmbiguousOption`
 
@@ -240,7 +240,7 @@ def rename_window(self, new_name):
         """Return :class:`Window` object ``$ tmux rename-window <new_name>``.
 
         :param new_name: name of the window
-        :type new_name: string
+        :type new_name: str
 
         """
 
@@ -281,10 +281,10 @@ def move_window(self, destination="", session=None):
 
         :param destination: the ``target window`` or index to move the window
             to, default: empty string
-        :type destination: string
+        :type destination: str
         :param session: the ``target session`` or index to move the
             window to, default: current session.
-        :type session: string
+        :type session: str
 
         """
         session = session or self.get('session_id')
@@ -317,7 +317,7 @@ def select_pane(self, target_pane):
 
         :param target_pane: ``target_pane``, or ``-U``,``-D``, ``-L``, ``-R``
             or ``-l``.
-        :type target_pane: string
+        :type target_pane: str
         :rtype: :class:`Pane`
 
         """
@@ -368,7 +368,7 @@ def split_window(
         :type attach: bool
         :param start_directory: specifies the working directory in which the
             new window is created.
-        :type start_directory: string
+        :type start_directory: str
         :param target: ``target_pane`` to split.
         :type target: bool
         :param vertical: split vertically