Merge pull request faif#227 from GiantsLoveDeathMetal/add-about-to-chain

faif · web-flow · commit 3ea0a9374369 · 2018-06-11T19:26:48.000+02:00
Add description to chain pattern
diff --git a/behavioral/chain.py b/behavioral/chain.py
@@ -2,7 +2,22 @@
 # -*- coding: utf-8 -*-
 
 """
+*What is this pattern about?
+This pattern aims to decouple the senders of a request from its
+receivers. It does this by allowing a request to move through chained
+objects until it is handled by an appropriate receiver.
+
+This is useful as it reduces the number of connections between objects,
+since the sender does not need explicit knowledge of the handler, and
+the receiver won't need to refer to all potential receivers, but keeps
+a reference to a single successor.
+
+*References:
 http://www.dabeaz.com/coroutines/
+
+*TL;DR80
+Allow a request to pass down a chain of objects until an object handles
+the request.
 """
 
 from contextlib import contextmanager
