:py:mod:`buildtest.tools.editor`
================================

.. py:module:: buildtest.tools.editor


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   buildtest.tools.editor.set_editor



.. py:function:: set_editor(editor=None)

   Set the editor used for editing files. The editor can be set based on environment ``EDITOR`` or passed as argument
   ``buildtest --editor``. The editor must be one of the following: vi, vim, emacs, nano.

   We check the path to editor before setting value to editor.

   :param editor: Select choice of editor specified via ``buildtest --editor``
   :type editor: str, optional

   :returns: Return full path to editor
   :rtype: str