[Zope-Checkins] CVS: Packages/ZConfig/doc - zconfig.tex:1.18
Fred L. Drake, Jr.
fred@zope.com
Fri, 22 Nov 2002 11:43:49 -0500
Update of /cvs-repository/Packages/ZConfig/doc
In directory cvs.zope.org:/tmp/cvs-serv9561
Modified Files:
zconfig.tex
Log Message:
Document the pubilc attributes for Configuration objects.
=== Packages/ZConfig/doc/zconfig.tex 1.17 => 1.18 ===
--- Packages/ZConfig/doc/zconfig.tex:1.17 Thu Nov 21 14:21:08 2002
+++ Packages/ZConfig/doc/zconfig.tex Fri Nov 22 11:43:48 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
@@ -409,6 +419,18 @@
Return a list of keys from this section, including any available
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