Commits

Georg Bauer committed 1d94849

added commentary to the main module

  • Participants
  • Parent commits 36a7fab

Comments (0)

Files changed (1)

dynscope/__init__.py

+"""
+This module provides the basic interface to work with dynamically
+scoped variables. It provides the following functions for that:
+
+construct() returns a dynamic scope object and a function to introduce
+local dynamic bindings.
+
+fluid is the default dynamic scope set up ready to use.
+
+flet(**kw) is the function to introduce local bindings on fluid. It
+returns a context manager that is used in combination with the with
+statement and will handle unwinding of dynamic namespaces.
+"""
 __version__ = '0.1'
 
 from fluids import DynamicScope