[Zodb-checkins] CVS: Zope/lib/python/ZConfig/doc - zconfig.tex:1.5.4.5

Chris McDonough chrism@zope.com
Sun, 24 Nov 2002 18:28:46 -0500


Update of /cvs-repository/Zope/lib/python/ZConfig/doc
In directory cvs.zope.org:/tmp/cvs-serv6683/doc

Modified Files:
      Tag: chrism-install-branch
	zconfig.tex 
Log Message:
Merge with head.


=== Zope/lib/python/ZConfig/doc/zconfig.tex 1.5.4.4 => 1.5.4.5 ===
--- Zope/lib/python/ZConfig/doc/zconfig.tex:1.5.4.4	Fri Nov 15 20:26:17 2002
+++ Zope/lib/python/ZConfig/doc/zconfig.tex	Sun Nov 24 18:28:44 2002
@@ -349,8 +349,18 @@
   and changes the lookup semantics of the \method{get()} method.
 \end{classdesc}
 
-\class{Configuration} objects provide the following methods to
-retrieve values from the section:
+\class{Configuration} objects provide the following attributes and
+methods to retrieve information from the section:
+
+\begin{memberdesc}[Configuration]{container}
+  The containing section of this section, or \code{None}.
+\end{memberdesc}
+
+\begin{memberdesc}[Configuration]{delegate}
+  The \class{Configuration} object to which lookups are delegated when
+  they cannot be satisfied directly.  If there is no such section,
+  this will be \code{None}.
+\end{memberdesc}
 
 \begin{methoddesc}[Configuration]{get}{key\optional{, default}}
   Returns the value for \var{key} as a string; a value from the
@@ -410,6 +420,18 @@
   from the delegate section.
 \end{methoddesc}
 
+\begin{memberdesc}[Configuration]{name}
+  The name of this section, or \code{None}.
+\end{memberdesc}
+
+\begin{memberdesc}[Configuration]{type}
+  The type of this section as a string.
+\end{memberdesc}
+
+\begin{memberdesc}[Configuration]{url}
+  The URL of the source this section was loaded from.
+\end{memberdesc}
+
 
 The following methods are used to modify the values defined in a
 section:
@@ -439,9 +461,11 @@
   section.
 \end{methoddesc}
 
-\begin{methoddesc}[Configuration]{getChildSections}{}
+\begin{methoddesc}[Configuration]{getChildSections}{\optional{type}}
   Returns a sequence of all child sections, in the order in which they
-  were added.
+  were added.  If \var{type} is omitted or \code{None}, all sections
+  are returned; otherwise only sections of the specified type are
+  included.  The delegate is never consulted by this method.
 \end{methoddesc}
 
 \begin{methoddesc}[Configuration]{getSection}{type\optional{, name}}