Commits

Dag Odenhall committed d75bd92

Document exceptions and internal utilities

  • Participants
  • Parent commits 564413c

Comments (0)

Files changed (4)

    validation/index
    markup
    signals
+   utils
    patterns/index
    project

docs/schema/exceptions.rst

+Exceptions
+==========
+
+.. automodule:: flatland.exc

docs/schema/index.rst

    schema
    traversal
    properties
+   exceptions
 
 
 Element Types
+Internal Utilities
+==================
+
+The utilities documented here are all importable directly from
+``flatland.util``, and may be useful for implementing custom schema types
+and validators using similar semantics to Flatland, or if you're hacking on
+Flatland internals yourself.  Typical users, however, need not know about
+these utilities.
+
+
+``flatland.util.base``
+----------------------
+
+.. automodule:: flatland.util.base
+
+
+``flatland.util.deferred``
+--------------------------
+
+.. automodule:: flatland.util.deferred