From 2462135da0f230b9795755fbf7e9bd917d13acf3 Mon Sep 17 00:00:00 2001
From: Jason Gerard DeRose <jderose@redhat.com>
Date: Mon, 5 Jan 2009 12:41:02 -0700
Subject: Added a few missing things to base.ReadOnly docstrings

---
 ipalib/base.py | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

(limited to 'ipalib')

diff --git a/ipalib/base.py b/ipalib/base.py
index d83948747..bff8f1951 100644
--- a/ipalib/base.py
+++ b/ipalib/base.py
@@ -18,7 +18,7 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 """
-Core functions and classes.
+Foundational classes and functions.
 """
 
 import re
@@ -54,7 +54,11 @@ class ReadOnly(object):
 
     But after an instance is locked, you cannot set its attributes:
 
+    >>> p.__islocked__()  # Is this instance locked?
+    False
     >>> p.__lock__()  # This will lock the instance
+    >>> p.__islocked__()
+    True
     >>> p.department = 'Engineering'
     Traceback (most recent call last):
       ...
@@ -79,7 +83,20 @@ class ReadOnly(object):
     False
 
     But again, the point is that a programmer would never employ the above
-    techniques accidentally.
+    techniques *accidentally*.
+
+    Lastly, this example aside, you should use the `lock()` function rather
+    than the `ReadOnly.__lock__()` method.  And likewise, you should
+    use the `islocked()` function rather than the `ReadOnly.__islocked__()`
+    method.  For example:
+
+    >>> readonly = ReadOnly()
+    >>> islocked(readonly)
+    False
+    >>> lock(readonly) is readonly  # lock() returns the instance
+    True
+    >>> islocked(readonly)
+    True
     """
 
     __locked = False
-- 
cgit