Clarify that immutability isn't recursive

hynek · Aug 16, 2014 · 2bc9216 · 2bc9216
1 parent 04a903d
commit 2bc9216
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -111,6 +111,23 @@ The easiest way to get started is to have a look at the :doc:`examples` to get a
       TypeError: Attribute 'foo' of class 'ImmutableClass' is immutable.
 
 
+   Please note, that that doesn't mean that the attributes themselves are immutable too:
+
+   .. doctest::
+
+      >>> @immutable(["foo"])
+      ... class C(object):
+      ...     foo = []
+      >>> i = C()
+      >>> i.foo = [42]
+      Traceback (most recent call last):
+       ...
+      TypeError: Attribute 'foo' of class 'C' is immutable.
+      >>> i.foo.append(42)
+      >>> i.foo
+      [42]
+
+
 .. autoclass:: Attribute
 
 .. autodata:: NOTHING