Commit b1dd2ccd authored by Amos Latteier's avatar Amos Latteier

API Docs formatting and spelling clean up.

parent d423f925
......@@ -83,10 +83,6 @@
#
##############################################################################
"""
Authenticated User
"""
class AuthenticatedUser:
"""
This interface needs to be supported by objects that
......@@ -97,9 +93,9 @@ class AuthenticatedUser:
def getUserName():
"""
Return the username of a user
Return the name of a user
Permission - Allways available
Permission - Always available
"""
......@@ -109,7 +105,7 @@ class AuthenticatedUser:
Return a value that is true if the user has the given roles on
the given object and return false otherwise.
Permission - Allways available
Permission - Always available
"""
......@@ -119,7 +115,7 @@ class AuthenticatedUser:
Returns a list of the roles the user has on the given object
(in the current context?)
Permission - Allways available
Permission - Always available
"""
......
......@@ -83,10 +83,6 @@
#
##############################################################################
"""
DTMLDocument
"""
class DTMLDocument:
"""
A DTML Document is a Zope object that contains and executes DTML
......
......@@ -83,10 +83,6 @@
#
##############################################################################
"""
DTMLMethod
"""
class DTMLMethod:
"""
A DTML Method is a Zope object that contains and executes DTML
......
......@@ -83,10 +83,6 @@
#
##############################################################################
"""
File
"""
class File:
"""
A File is a Zope object that contains file content. A File object
......
......@@ -83,10 +83,6 @@
#
##############################################################################
"""
Image
"""
class Image:
"""
A Image is a Zope object that contains image content. A Image
......
......@@ -83,10 +83,6 @@
#
##############################################################################
"""
ObjectManager
"""
class ObjectManager:
"""
An ObjectManager contains other Zope objects. The contained
......
......@@ -83,10 +83,6 @@
#
##############################################################################
"""
ObjectManagerItem
"""
class ObjectManagerItem:
"""
A Zope object that can be contained within an Object Manager.
......@@ -170,7 +166,7 @@ class ObjectManagerItem:
virtual hosts are being used, then the path returned is a
logical, rather than a physical path.
Permission --Allways available
Permission --Always available
"""
def getPhysicalRoot(self):
......
......@@ -83,9 +83,6 @@
#
##############################################################################
"""PropertyManager
"""
class PropertyManager:
"""
A Property Manager object has a collection of typed attributes
......
......@@ -83,17 +83,12 @@
#
##############################################################################
"""
PropertySheet
"""
class PropertySheet:
""""
A PropertySheet is an abstraction for organizing and working
with a set of related properties. Conceptually it acts like a
container for a set of related properties and metadata describing
container for a set of related properties and meta-data describing
those properties. A PropertySheet may or may not provide a web
interface for managing its properties.
......@@ -105,7 +100,7 @@ class PropertySheet:
Return a namespace string usable as an xml namespace
for this property set. This may be an empty string if
there is no default namespace for a given property sheet
(esp. property sheets added in ZClass definitions).
(especially property sheets added in ZClass definitions).
"""
......@@ -168,7 +163,7 @@ class PropertySheet:
def propertyInfo(self):
"""
Returns a mapping containing property metadata.
Returns a mapping containing property meta-data.
"""
......
......@@ -83,31 +83,24 @@
#
##############################################################################
"""
PropertySheets
"""
class PropertySheets:
"""
A PropertySheet is an abstraction for organizing and working with
a set of related properties. Conceptually it acts like a container
for a set of related properties and metadata describing those
for a set of related properties and meta-data describing those
properties. PropertySheet objects are accessed through a
PropertySheets object that acts as a collection of PropertySheet
instances.
Objects that support property sheets (objects that support the
PropertyManager interface or ZClass objects) have a
'propertysheets'
attribute (a PropertySheets instance) that is the collection of
PropertySheet objects. The PropertySheets object exposes an
interface much like a Python mapping, so that individual
PropertySheet objects
may be accessed via dictionary-style key indexing.
'propertysheets' attribute (a PropertySheets instance) that is the
collection of PropertySheet objects. The PropertySheets object
exposes an interface much like a Python mapping, so that
individual PropertySheet objects may be accessed via
dictionary-style key indexing.
"""
......
......@@ -70,7 +70,7 @@
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
z# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment