Merge pull request faif#213 from egens/add-tldr-comments

Add tl;dr80 comment for most of the patterns.

Author: faif

behavioral/catalog.py

@@ -1,9 +1,11 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+
 """
 A class that uses different static function depending of a parameter passed in
 init. Note the use of a single dictionary instead of multiple conditions
 """
+
 __author__="Ibrahim Diop <[email protected]>"
 
 

behavioral/chain.py

@@ -1,6 +1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-"""http://www.dabeaz.com/coroutines/"""
+
+"""
+http://www.dabeaz.com/coroutines/
+"""
 
 fromcontextlibimportcontextmanager
 importos

behavioral/command.py

@@ -1,5 +1,11 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+
+"""
+*TL;DR80
+Encapsulates all information needed to perform an action or trigger an event.
+"""
+
 from __future__ importprint_function
 importos
 fromos.pathimportlexists

behavioral/iterator.py

@@ -1,8 +1,12 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+
 """
 http://ginstrom.com/scribbles/2007/10/08/design-patterns-python-style/
 Implementation of the iterator pattern with a generator
+
+*TL;DR80
+Traverses a container and accesses the container's elements.
 """
 
 from __future__ importprint_function

behavioral/mediator.py

@@ -1,6 +1,12 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-"""http://web.archive.org/web/20120309135549/http://dpip.testingperspective.com/?p=28"""
+
+"""
+http://web.archive.org/web/20120309135549/http://dpip.testingperspective.com/?p=28
+
+*TL;DR80
+Encapsulates how a set of objects interact.
+"""
 
 importrandom
 importtime

behavioral/memento.py

@@ -1,6 +1,12 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-"""http://code.activestate.com/recipes/413838-memento-closure/"""
+
+"""
+http://code.activestate.com/recipes/413838-memento-closure/
+
+*TL;DR80
+Provides the ability to restore an object to its previous state.
+"""
 
 fromcopyimportcopy
 fromcopyimportdeepcopy

behavioral/observer.py

@@ -1,7 +1,14 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+
+"""
+http://code.activestate.com/recipes/131499-observer-pattern/
+
+*TL;DR80
+Maintains a list of dependents and notifies them of any state changes.
+"""
+
 from __future__ importprint_function
-"""http://code.activestate.com/recipes/131499-observer-pattern/"""
 
 
 classSubject(object):

behavioral/specification.py

@@ -1,10 +1,11 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+
 """
 @author: Gordeev Andrey <[email protected]>
 
-Specification provide recombination business logic by
-chaining together using boolean logic
+*TL;DR80
+Provides recombination business logic by chaining together using boolean logic.
 """
 
 fromabcimportabstractmethod

behavioral/state.py

@@ -1,8 +1,16 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-"""Implementation of the state pattern"""
 
-# http://ginstrom.com/scribbles/2007/10/08/design-patterns-python-style/
+"""
+Implementation of the state pattern
+
+http://ginstrom.com/scribbles/2007/10/08/design-patterns-python-style/
+
+*TL;DR80
+Implements state as a derived class of the state pattern interface.
+Implements state transitions by invoking methods from the pattern's superclass.
+"""
+
 from __future__ importprint_function
 
 

behavioral/strategy.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+
 """
 http://stackoverflow.com/questions/963965/how-is-this-strategy-pattern
  -written-in-python-the-sample-in-wikipedia
@@ -9,7 +10,11 @@
 http://en.wikipedia.org/wiki/Strategy_pattern), however Python supports
 higher-order functions and allows us to have only one class and inject
 functions into it's instances, as shown in this example.
+
+*TL;DR80
+Enables selecting an algorithm at runtime.
 """
+
 importtypes