update annotations

docs/source/readme_title.rst

@@ -27,6 +27,6 @@ python_hangman
     :alt: Documentation Status
 
 
-A python version agnostic, tox tested, travis-backed program! Documented and distributed.
 
-Has **very high** unit test coverage, with passing tests on every relevant version of python including PyPy.
+
+A well tested, cli, python version-agnostic, multi-platform hangman game. It's built following a TDD workflow and a MVC design pattern. Each component services a sensibly distinct logical purpose.  Python Hangman is a version agnostic, tox tested, travis-backed program! Documented and distributed.

hangman/__init__.py

@@ -5,12 +5,13 @@
 python_hangman
 ==============
 
-A well tested, cli, python version-agnostic, multi-platform hangman game.
-It's built following TDD principles and each component services a
-sensibly distinct logical purpose.
+A well tested, cli, python version-agnostic, multi-platform hangman game. It's built following a TDD workflow and a
+MVC design pattern. Each component services a sensibly distinct logical purpose.  Python Hangman is a version
+agnostic, tox tested, travis-backed program! Documented and distributed.
 
 """
 from __future__ import absolute_import
+
 import logging
 
 from ._compat import NullHandler

hangman/__main__.py

@@ -14,9 +14,6 @@
 
 @click.command()
 def cli():
-    """
-    Start a new game.
-    """
     controller.run()
 
 

hangman/controller.py

@@ -2,8 +2,6 @@
 """
 hangman.controller
 ~~~~~~~~~~~~~~~~~~
-
-This module is responsible for guiding the user through the game.
 """
 from __future__ import absolute_import
 
@@ -31,9 +29,9 @@ def game_loop(game=Hangman(), flash=FlashMessage()):
 
 def run(game=Hangman(), flash=FlashMessage()):
     """
-    Run ``game_loop``, handle exit.
+    Run ``game_loop`` and handle exiting.
 
-    Logic is separated from game_loop to cleanly avoid recursion limits.
+    Logic is separated from game_loop to cleanly avoid python recursion limits.
 
     :param hangman.model.Hangman game: Hangman game instance.
     :param hangman.utils.FlashMessage flash: FlashMessage utility
@@ -45,7 +43,7 @@ def run(game=Hangman(), flash=FlashMessage()):
         try:
             game_loop(game=game, flash=flash)
         except KeyboardInterrupt:
-            # Exit immediately
+            # exit immediately
             return view.say_goodbye()
 
         if not view.prompt_play_again():

hangman/model.py

@@ -2,8 +2,6 @@
 """
 hangman.model
 ~~~~~~~~~~~~~
-
-This module contains all of the game logic.
 """
 from __future__ import absolute_import
 import re

hangman/utils.py

@@ -33,6 +33,8 @@ def set(cls, *values):
         """
         Set `WordBank` word list.
 
+        Useful for testing.
+
         :param tuple values:
         """
         cls.WORDS = list(values)
@@ -56,28 +58,21 @@ class FlashMessage(object):
     game_answer = ''
 
     def __call__(self, message):
-        """
-        Set message to be flashed.
+        """Set message to be flashed."""
 
-        :param str message:
-        """
         self.message = str(message)
 
     def __str__(self):
-        """
-        Returns and clears the message
+        """Returns and clears the message"""
 
-        :return: Flashed message.
-        :rtype: str
-        """
         message, self.message = self.message, ''
         return str(message)
 
     def __bool__(self):
         # Python3 compatibility
-        return bool(self.message)
+        return self.__nonzero__()
 
-    def __nonzero__(self):  # pragma: no cover
+    def __nonzero__(self):
         # Python2 compatibility
         return bool(self.message)
 

setup.py

@@ -39,7 +39,7 @@ def run_tests(self):
 setup(  # :off
     name='python_hangman',
     version='2.2.0',
-    description='Python Hangman TDD demonstration.',
+    description='Python Hangman TDD/MVC demonstration.',
     long_description='\n\n'.join([readme, history]),
     author='Manu Phatak',
     author_email='bionikspoon@gmail.com',