form module docs

Pylons · Apr 14, 2012 · 075dadd · 075dadd
1 parent 8394cca
commit 075dadd
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -196,6 +196,17 @@ Other Helpers
 
 .. autofunction:: includeme
 
+:mod:`substanced.form` API
+----------------------------
+
+.. automodule:: substanced.form
+
+.. autoclass:: Form
+   :members:
+
+.. autoclass:: FormView
+   :members:
+
 :mod:`substanced.objectmap` API
 --------------------------------
 

diff --git a/substanced/form/__init__.py b/substanced/form/__init__.py
@@ -50,9 +50,14 @@
 resource_registry.registry = default_resources
 
 class Form(deform.form.Form):
+    """ Subclass of ``deform.form.Form`` which uses a custom resource
+    registry designed for Substance D. XXX point at deform docs. """
     default_resource_registry = resource_registry
 
 class FormView(object):
+    """ A class which can be used as a view which introspects a schema to
+    present the form.  XXX describe better using ``pyramid_deform``
+    documentation."""
     form_class = Form
     buttons = ()
     schema = None