[Zope-Checkins] SVN: Zope/branches/2.12/ - LP #142535: Fix faulty docstring for manage_changeProperties which

[Jens Vagelpohl]

Log message for revision 113517:
  - LP #142535: Fix faulty docstring for manage_changeProperties which
    incorrectly suggested that passing a simple dictionary as REQUEST
    argument was supported.
  

Changed:
  U   Zope/branches/2.12/doc/CHANGES.rst
  U   Zope/branches/2.12/src/OFS/PropertyManager.py
  U   Zope/branches/2.12/src/OFS/PropertySheets.py
  U   Zope/branches/2.12/src/OFS/interfaces.py
  U   Zope/branches/2.12/src/Products/OFSP/help/PropertySheet.py

-=-
Modified: Zope/branches/2.12/doc/CHANGES.rst
===================================================================
--- Zope/branches/2.12/doc/CHANGES.rst	2010-06-16 10:36:09 UTC (rev 113516)
+++ Zope/branches/2.12/doc/CHANGES.rst	2010-06-16 10:53:19 UTC (rev 113517)
@@ -25,6 +25,10 @@
 Bugs Fixed
 ++++++++++
 
+- LP #142535: Fix faulty docstring for manage_changeProperties which 
+  incorrectly suggested that passing a simple dictionary as REQUEST 
+  argument was supported.
+
 - LP #583702: Fixed regression in mailhost queue processor code introduced
   in 2.12.6 in the LP #574286 changes.
 

Modified: Zope/branches/2.12/src/OFS/PropertyManager.py
===================================================================
--- Zope/branches/2.12/src/OFS/PropertyManager.py	2010-06-16 10:36:09 UTC (rev 113516)
+++ Zope/branches/2.12/src/OFS/PropertyManager.py	2010-06-16 10:53:19 UTC (rev 113517)
@@ -316,8 +316,8 @@
     def manage_changeProperties(self, REQUEST=None, **kw):
         """Change existing object properties.
 
-        Change object properties by passing either a mapping object
-        of name:value pairs {'foo':6} or passing name=value parameters
+        Change object properties by passing either a REQUEST object or
+        name=value parameters
         """
         if REQUEST is None:
             props={}

Modified: Zope/branches/2.12/src/OFS/PropertySheets.py
===================================================================
--- Zope/branches/2.12/src/OFS/PropertySheets.py	2010-06-16 10:36:09 UTC (rev 113516)
+++ Zope/branches/2.12/src/OFS/PropertySheets.py	2010-06-16 10:53:19 UTC (rev 113517)
@@ -441,9 +441,11 @@
 
     security.declareProtected(manage_properties, 'manage_changeProperties')
     def manage_changeProperties(self, REQUEST=None, **kw):
-        """Change existing object properties by passing either a mapping
-           object of name:value pairs {'foo':6} or passing name=value
-           parameters."""
+        """Change existing object properties.
+
+        Change object properties by passing either a REQUEST object or
+        name=value parameters
+        """
         if REQUEST is None:
             props={}
         else: props=REQUEST

Modified: Zope/branches/2.12/src/OFS/interfaces.py
===================================================================
--- Zope/branches/2.12/src/OFS/interfaces.py	2010-06-16 10:36:09 UTC (rev 113516)
+++ Zope/branches/2.12/src/OFS/interfaces.py	2010-06-16 10:53:19 UTC (rev 113517)
@@ -797,8 +797,8 @@
     def manage_changeProperties(REQUEST=None, **kw):
         """Change existing object properties.
 
-        Change object properties by passing either a mapping object
-        of name:value pairs {'foo':6} or passing name=value parameters
+        Change object properties by passing either a REQUEST object or
+        name=value parameters
         """
 
     def manage_changePropertyTypes(old_ids, props, REQUEST=None):

Modified: Zope/branches/2.12/src/Products/OFSP/help/PropertySheet.py
===================================================================
--- Zope/branches/2.12/src/Products/OFSP/help/PropertySheet.py	2010-06-16 10:36:09 UTC (rev 113516)
+++ Zope/branches/2.12/src/Products/OFSP/help/PropertySheet.py	2010-06-16 10:53:19 UTC (rev 113517)
@@ -165,9 +165,8 @@
     def manage_changeProperties(REQUEST=None, **kw):
         """
 
-        Change existing object properties by passing either a mapping
-        object as 'REQUEST' containing name:value pairs or by passing
-        name=value keyword arguments.
+        Change object properties by passing either a REQUEST object or
+        name=value parameters
 
         Some objects have "special" properties defined by product
         authors that cannot be changed. If you try to change one of
@@ -178,7 +177,7 @@
         ensure that the updated values are of the correct type.
         *This should probably change*.
 
-        If a value is provided for 'REQUEST' (as it will be when
+        If a REQUEST object is passed (as it will be when
         called via the web), the method will return an HTML message
         dialog. If no REQUEST is passed, the method returns 'None' on
         success.