[Checkins] SVN: zc.zk/trunk/src/zc/zk/README.txt Fixed: The documentation for get_properties was missleading.

jim cvs-admin at zope.org
Fri Aug 10 16:46:50 UTC 2012


Log message for revision 127464:
  Fixed: The documentation for get_properties was missleading.
  

Changed:
  U   zc.zk/trunk/src/zc/zk/README.txt

-=-
Modified: zc.zk/trunk/src/zc/zk/README.txt
===================================================================
--- zc.zk/trunk/src/zc/zk/README.txt	2012-08-10 14:00:54 UTC (rev 127463)
+++ zc.zk/trunk/src/zc/zk/README.txt	2012-08-10 16:46:46 UTC (rev 127464)
@@ -997,12 +997,15 @@
    object.
 
 ``get_properties(path)``
-   Get the properties for the node at the given path as a dictionary.
+   Get the raw properties for the node at the given path as a dictionary.
 
-   This is more efficient than ``properties`` when all you need is to
-   read the properties once, as it doesn't create a
-   `zc.zk.Properties`_ object.
+   This method is mainly for internal use.  Because it doesn't resolve
+   property links, it's of dubious use for applications.
 
+   (It's only included in the documentation because it was included
+    before with a suggestion that it was more efficient than
+    ``properties``, which it is if you just want raw data.)
+
 ``import_tree(text[, path='/'[, trim[, acl[, dry_run]]]])``
     Create tree nodes by importing a textual tree representation.
 
@@ -1165,6 +1168,12 @@
 Change History
 ==============
 
+
+0.9.2 (2012-08-10)
+------------------
+
+- Fixed: The documentation for get_properties was missleading.
+
 0.9.2 (2012-08-08)
 ------------------
 



More information about the checkins mailing list