Updated documentation

dayorbyte · Oct 8, 2010 · 51e12f6 · 51e12f6
1 parent 881ec01
commit 51e12f6
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 32 deletions.
diff --git a/docs/build/html/api/schema/document.html b/docs/build/html/api/schema/document.html
@@ -100,7 +100,9 @@ <h2><a class="reference internal" href="#mongoalchemy.document.Document" title="
 <dt id="mongoalchemy.document.Document.config_extra_fields">
 <tt class="descname">config_extra_fields</tt><a class="headerlink" href="#mongoalchemy.document.Document.config_extra_fields" title="Permalink to this definition">¶</a></dt>
 <dd><p>Controls the method to use when dealing with fields passed in to the
-document constructor.  Possible values are &#8216;error&#8217; and &#8216;ignore&#8217;</p>
+document constructor.  Possible values are &#8216;error&#8217; and &#8216;ignore&#8217;. Any
+fields which couldn&#8217;t be mapped can be retrieved (and edited) using
+<a class="reference internal" href="#mongoalchemy.document.Document.get_extra_fields" title="mongoalchemy.document.Document.get_extra_fields"><tt class="xref py py-func docutils literal"><span class="pre">get_extra_fields()</span></tt></a></p>
 </dd></dl>
 
 <dl class="attribute">
@@ -116,6 +118,13 @@ <h2><a class="reference internal" href="#mongoalchemy.document.Document" title="
 </div>
 </dd></dl>
 
+<dl class="method">
+<dt id="mongoalchemy.document.Document.get_extra_fields">
+<tt class="descname">get_extra_fields</tt><big>(</big><big>)</big><a class="headerlink" href="#mongoalchemy.document.Document.get_extra_fields" title="Permalink to this definition">¶</a></dt>
+<dd><p>if <a class="reference internal" href="#mongoalchemy.document.Document.config_extra_fields" title="mongoalchemy.document.Document.config_extra_fields"><tt class="xref py py-attr docutils literal"><span class="pre">Document.config_extra_fields</span></tt></a> is set to &#8216;ignore&#8217;, this method will return
+a dictionary of the fields which couldn&#8217;t be mapped to the document.</p>
+</dd></dl>
+
 <dl class="classmethod">
 <dt id="mongoalchemy.document.Document.get_fields">
 <em class="property">classmethod </em><tt class="descname">get_fields</tt><big>(</big><big>)</big><a class="headerlink" href="#mongoalchemy.document.Document.get_fields" title="Permalink to this definition">¶</a></dt>