[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/dublincore/ Update
doc strings to ReST
Phil Ruggera
pruggera at san.rr.com
Fri Jul 23 17:55:49 EDT 2004
Log message for revision 26734:
Update doc strings to ReST
Changed:
U Zope3/trunk/src/zope/app/dublincore/annotatableadapter.py
U Zope3/trunk/src/zope/app/dublincore/browser/metadataedit.py
U Zope3/trunk/src/zope/app/dublincore/creatorannotator.py
U Zope3/trunk/src/zope/app/dublincore/dcsv.py
U Zope3/trunk/src/zope/app/dublincore/dcterms.py
U Zope3/trunk/src/zope/app/dublincore/fssync/adapter.py
U Zope3/trunk/src/zope/app/dublincore/interfaces.py
U Zope3/trunk/src/zope/app/dublincore/timeannotators.py
U Zope3/trunk/src/zope/app/dublincore/xmlmetadata.py
U Zope3/trunk/src/zope/app/dublincore/zopedublincore.py
-=-
Modified: Zope3/trunk/src/zope/app/dublincore/annotatableadapter.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/annotatableadapter.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/annotatableadapter.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from persistent.dict import PersistentDict
from zope.app.annotation.interfaces import IAnnotations, IAnnotatable
Modified: Zope3/trunk/src/zope/app/dublincore/browser/metadataedit.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/browser/metadataedit.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/browser/metadataedit.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from datetime import datetime
from zope.event import notify
from zope.app.event.objectevent import ObjectAnnotationsModifiedEvent
Modified: Zope3/trunk/src/zope/app/dublincore/creatorannotator.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/creatorannotator.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/creatorannotator.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.dublincore.interfaces import IZopeDublinCore
from zope.security.management import queryInteraction
Modified: Zope3/trunk/src/zope/app/dublincore/dcsv.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/dcsv.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/dcsv.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -11,7 +11,7 @@
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
-"""Functions for working with Dublin Core Structured Value (DCSV) data.
+"""Functions for working with Dublin Core Structured Values (DCSV) scheme.
DCSV is specified in 'DCMI DCSV: A syntax for writing a list of
labelled values in a text string', at:
@@ -20,6 +20,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
import re
Modified: Zope3/trunk/src/zope/app/dublincore/dcterms.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/dcterms.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/dcterms.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -11,10 +11,11 @@
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
-"""Support information for qualified Dublin Core metadata.
+"""Support information for qualified Dublin Core Metadata.
$Id$
"""
+__docformat__ = 'restructuredtext'
from zope.app.dublincore import dcsv
Modified: Zope3/trunk/src/zope/app/dublincore/fssync/adapter.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/fssync/adapter.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/fssync/adapter.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import implements
from zope.fssync.server.entryadapter import ObjectEntryAdapter
Modified: Zope3/trunk/src/zope/app/dublincore/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/interfaces.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/interfaces.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.annotation.interfaces import IAnnotatable
from zope.interface import Interface
from zope.schema import Text, TextLine, Datetime, List
@@ -115,98 +117,98 @@
class IWritableGeneralDublinCore(Interface):
"""Provide write access to dublin core data
- This interface augments IStandardDublinCore with methods for
+ This interface augments `IStandardDublinCore` with methods for
writing elements.
"""
def setQualifiedTitles(qualified_titles):
"""Set the qualified Title elements.
- The argument must be a sequence of IDublinCoreElementItem.
+ The argument must be a sequence of `IDublinCoreElementItem`.
"""
def setQualifiedCreators(qualified_creators):
"""Set the qualified Creator elements.
- The argument must be a sequence of Creator IDublinCoreElementItem.
+ The argument must be a sequence of Creator `IDublinCoreElementItem`.
"""
def setQualifiedSubjects(qualified_subjects):
"""Set the qualified Subjects elements.
- The argument must be a sequence of Subject IDublinCoreElementItem.
+ The argument must be a sequence of Subject `IDublinCoreElementItem`.
"""
def setQualifiedDescriptions(qualified_descriptions):
"""Set the qualified Descriptions elements.
- The argument must be a sequence of Description IDublinCoreElementItem.
+ The argument must be a sequence of Description `IDublinCoreElementItem`.
"""
def setQualifiedPublishers(qualified_publishers):
"""Set the qualified Publishers elements.
- The argument must be a sequence of Publisher IDublinCoreElementItem.
+ The argument must be a sequence of Publisher `IDublinCoreElementItem`.
"""
def setQualifiedContributors(qualified_contributors):
"""Set the qualified Contributors elements.
- The argument must be a sequence of Contributor IDublinCoreElementItem.
+ The argument must be a sequence of Contributor `IDublinCoreElementItem`.
"""
def setQualifiedDates(qualified_dates):
"""Set the qualified Dates elements.
- The argument must be a sequence of Date IDublinCoreElementItem.
+ The argument must be a sequence of Date `IDublinCoreElementItem`.
"""
def setQualifiedTypes(qualified_types):
"""Set the qualified Types elements.
- The argument must be a sequence of Type IDublinCoreElementItem.
+ The argument must be a sequence of Type `IDublinCoreElementItem`.
"""
def setQualifiedFormats(qualified_formats):
"""Set the qualified Formats elements.
- The argument must be a sequence of Format IDublinCoreElementItem.
+ The argument must be a sequence of Format `IDublinCoreElementItem`.
"""
def setQualifiedIdentifiers(qualified_identifiers):
"""Set the qualified Identifiers elements.
- The argument must be a sequence of Identifier IDublinCoreElementItem.
+ The argument must be a sequence of Identifier `IDublinCoreElementItem`.
"""
def setQualifiedSources(qualified_sources):
"""Set the qualified Sources elements.
- The argument must be a sequence of Source IDublinCoreElementItem.
+ The argument must be a sequence of Source `IDublinCoreElementItem`.
"""
def setQualifiedLanguages(qualified_languages):
"""Set the qualified Languages elements.
- The argument must be a sequence of Language IDublinCoreElementItem.
+ The argument must be a sequence of Language `IDublinCoreElementItem`.
"""
def setQualifiedRelations(qualified_relations):
"""Set the qualified Relations elements.
- The argument must be a sequence of Relation IDublinCoreElementItem.
+ The argument must be a sequence of Relation `IDublinCoreElementItem`.
"""
def setQualifiedCoverages(qualified_coverages):
"""Set the qualified Coverages elements.
- The argument must be a sequence of Coverage IDublinCoreElementItem.
+ The argument must be a sequence of Coverage `IDublinCoreElementItem`.
"""
def setQualifiedRights(qualified_rights):
"""Set the qualified Rights elements.
- The argument must be a sequence of Rights IDublinCoreElementItem.
+ The argument must be a sequence of Rights `IDublinCoreElementItem`.
"""
class IDCDescriptiveProperties(Interface):
@@ -300,7 +302,7 @@
def Title():
"""Return the resource title.
- The first unqualified Dublin Core 'Title' element value is
+ The first unqualified Dublin Core `Title` element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned.
"""
@@ -311,14 +313,14 @@
Return the full name(s) of the author(s) of the content
object.
- The unqualified Dublin Core 'Creator' element values are
+ The unqualified Dublin Core `Creator` element values are
returned as a sequence of unicode strings.
"""
def Subject():
"""Return the resource subjects.
- The unqualified Dublin Core 'Subject' element values are
+ The unqualified Dublin Core `Subject` element values are
returned as a sequence of unicode strings.
"""
@@ -327,7 +329,7 @@
Return a natural language description of this object.
- The first unqualified Dublin Core 'Description' element value is
+ The first unqualified Dublin Core `Description` element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned.
"""
@@ -338,7 +340,7 @@
Return full formal name of the entity or person responsible
for publishing the resource.
- The first unqualified Dublin Core 'Publisher' element value is
+ The first unqualified Dublin Core `Publisher` element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned.
"""
@@ -348,14 +350,14 @@
Return any additional collaborators.
- The unqualified Dublin Core 'Contributor' element values are
+ The unqualified Dublin Core `Contributor` element values are
returned as a sequence of unicode strings.
"""
def Date():
"""Return the default date
- The first unqualified Dublin Core 'Date' element value is
+ The first unqualified Dublin Core `Date` element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned. The
string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
@@ -364,7 +366,7 @@
def CreationDate():
"""Return the creation date.
- The value of the first Dublin Core 'Date' element qualified by
+ The value of the first Dublin Core `Date` element qualified by
'creation' is returned as a unicode string if a qualified
element is defined, otherwise, an empty unicode string is
returned. The string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
@@ -373,7 +375,7 @@
def EffectiveDate():
"""Return the effective date
- The value of the first Dublin Core 'Date' element qualified by
+ The value of the first Dublin Core `Date` element qualified by
'effective' is returned as a unicode string if a qualified
element is defined, otherwise, an empty unicode string is
returned. The string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
@@ -382,7 +384,7 @@
def ExpirationDate():
"""Date resource expires.
- The value of the first Dublin Core 'Date' element qualified by
+ The value of the first Dublin Core `Date` element qualified by
'expiration' is returned as a unicode string if a qualified
element is defined, otherwise, an empty unicode string is
returned. The string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
@@ -391,7 +393,7 @@
def ModificationDate():
"""Date resource last modified.
- The value of the first Dublin Core 'Date' element qualified by
+ The value of the first Dublin Core `Date` element qualified by
'modification' is returned as a unicode string if a qualified
element is defined, otherwise, an empty unicode string is
returned. The string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
@@ -402,7 +404,7 @@
Return a human-readable type name for the resource.
- The first unqualified Dublin Core 'Type' element value is
+ The first unqualified Dublin Core `Type` element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned.
"""
@@ -413,7 +415,7 @@
Return the resource's MIME type (e.g., 'text/html',
'image/png', etc.).
- The first unqualified Dublin Core 'Format' element value is
+ The first unqualified Dublin Core `Format` element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned.
"""
@@ -431,7 +433,7 @@
Return the RFC language code (e.g., 'en-US', 'pt-BR')
for the resource.
- The first unqualified Dublin Core 'Language' element value is
+ The first unqualified Dublin Core `Language` element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned.
"""
@@ -442,7 +444,7 @@
Return a string describing the intellectual property status,
if any, of the resource. for the resource.
- The first unqualified Dublin Core 'Rights' element value is
+ The first unqualified Dublin Core `Rights` element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned.
"""
Modified: Zope3/trunk/src/zope/app/dublincore/timeannotators.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/timeannotators.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/timeannotators.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
from datetime import datetime
from zope.app.dublincore.interfaces import IZopeDublinCore
Modified: Zope3/trunk/src/zope/app/dublincore/xmlmetadata.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/xmlmetadata.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/xmlmetadata.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
import xml.sax
import xml.sax.handler
Modified: Zope3/trunk/src/zope/app/dublincore/zopedublincore.py
===================================================================
--- Zope3/trunk/src/zope/app/dublincore/zopedublincore.py 2004-07-23 21:35:13 UTC (rev 26733)
+++ Zope3/trunk/src/zope/app/dublincore/zopedublincore.py 2004-07-23 21:55:49 UTC (rev 26734)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from datetime import datetime
from zope.interface import implements
@@ -92,9 +94,9 @@
class ZopeDublinCore(object):
"""Zope Dublin Core Mixin
- Subclasses should define either _changed() or _p_changed.
+ Subclasses should define either `_changed()` or `_p_changed`.
- Just mix with Persistence to get a persistent version.
+ Just mix with `Persistence` to get a persistent version.
"""
implements(IZopeDublinCore)
@@ -110,25 +112,25 @@
title = ScalarProperty(u'Title')
def Title(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.title
creators = SequenceProperty(u'Creator')
def Creator(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.creators
subjects = SequenceProperty(u'Subject')
def Subject(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.subjects
description = ScalarProperty(u'Description')
def Description(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.description
publisher = ScalarProperty(u'Publisher')
@@ -140,7 +142,7 @@
contributors = SequenceProperty(u'Contributor')
def Contributors(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.contributors
def Date(self):
@@ -150,175 +152,175 @@
created = DateProperty(u'Date.Created')
def CreationDate(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return _scalar_get(self, u'Date.Created')
effective = DateProperty(u'Date.Effective')
def EffectiveDate(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return _scalar_get(self, u'Date.Effective')
expires = DateProperty(u'Date.Expires')
def ExpirationDate(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return _scalar_get(self, u'Date.Expires')
modified = DateProperty(u'Date.Modified')
def ModificationDate(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return _scalar_get(self, u'Date.Modified')
type = ScalarProperty(u'Type')
def Type(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.type
format = ScalarProperty(u'Format')
def Format(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.format
identifier = ScalarProperty(u'Identifier')
def Identifier(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.identifier
language = ScalarProperty(u'Language')
def Language(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.language
rights = ScalarProperty(u'Rights')
def Rights(self):
- "See IZopeDublinCore"
+ "See `IZopeDublinCore`"
return self.rights
def setQualifiedTitles(self, qualified_titles):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Title', qualified_titles)
def setQualifiedCreators(self, qualified_creators):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Creator', qualified_creators)
def setQualifiedSubjects(self, qualified_subjects):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Subject', qualified_subjects)
def setQualifiedDescriptions(self, qualified_descriptions):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Description', qualified_descriptions)
def setQualifiedPublishers(self, qualified_publishers):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Publisher', qualified_publishers)
def setQualifiedContributors(self, qualified_contributors):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Contributor', qualified_contributors)
def setQualifiedDates(self, qualified_dates):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Date', qualified_dates)
def setQualifiedTypes(self, qualified_types):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Type', qualified_types)
def setQualifiedFormats(self, qualified_formats):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Format', qualified_formats)
def setQualifiedIdentifiers(self, qualified_identifiers):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Identifier', qualified_identifiers)
def setQualifiedSources(self, qualified_sources):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Source', qualified_sources)
def setQualifiedLanguages(self, qualified_languages):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Language', qualified_languages)
def setQualifiedRelations(self, qualified_relations):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Relation', qualified_relations)
def setQualifiedCoverages(self, qualified_coverages):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Coverage', qualified_coverages)
def setQualifiedRights(self, qualified_rights):
- "See IWritableDublinCore"
+ "See `IWritableDublinCore`"
return _set_qualified(self, u'Rights', qualified_rights)
def getQualifiedTitles(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Title')
def getQualifiedCreators(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Creator')
def getQualifiedSubjects(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Subject')
def getQualifiedDescriptions(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Description')
def getQualifiedPublishers(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Publisher')
def getQualifiedContributors(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Contributor')
def getQualifiedDates(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Date')
def getQualifiedTypes(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Type')
def getQualifiedFormats(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Format')
def getQualifiedIdentifiers(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Identifier')
def getQualifiedSources(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Source')
def getQualifiedLanguages(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Language')
def getQualifiedRelations(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Relation')
def getQualifiedCoverages(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Coverage')
def getQualifiedRights(self):
- "See IStandardDublinCore"
+ "See `IStandardDublinCore`"
return _get_qualified(self, u'Rights')
More information about the Zope3-Checkins
mailing list