Commit 1af86643 authored by Bram Schoenmakers's avatar Bram Schoenmakers

Fix up docstrings.

parent a61d22d7
......@@ -36,9 +36,7 @@ from topydo.lib import TodoList
class CLIApplication(CLIApplicationBase):
"""
Class that represents the Command Line Interface of Topydo.
Handles input/output of the various subcommands.
Class that represents the (original) Command Line Interface of Topydo.
"""
def __init__(self):
super(CLIApplication, self).__init__()
......
......@@ -14,7 +14,10 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
""" Entry file for the Python todo.txt CLI. """
"""
Contains a base class for a CLI implementation of topydo and functions for the
I/O on the command-line.
"""
import getopt
import sys
......@@ -102,7 +105,8 @@ from topydo.lib.Utils import escape_ansi
class CLIApplicationBase(object):
"""
Base class for Command Line Interfaces (CLI) for topydo.
Base class for a Command Line Interfaces (CLI) for topydo. Examples are the
original CLI and the Prompt interface.
Handles input/output of the various subcommands.
"""
......
......@@ -14,7 +14,7 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
""" Entry file for the Python todo.txt CLI. """
""" Entry file for the topydo Prompt interface (CLI). """
import sys
......@@ -41,9 +41,8 @@ from topydo.lib import TodoList
class PromptApplication(CLIApplicationBase):
"""
Class that represents the Command Line Interface of Topydo.
Handles input/output of the various subcommand.
This class implements a variant of topydo's CLI showing a shell and
offering auto-completion thanks to the prompt toolkit.
"""
def __init__(self):
super(PromptApplication, self).__init__()
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment