Add aliasing examples

hynek · Aug 7, 2014 · 7f777eb · 7f777eb
1 parent 2992293
commit 7f777eb
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -61,3 +61,20 @@ It allows for things like default values for certain attributes, making them opt
    False
    >>> obj6.b is obj7.b
    False
+
+And if you want your classes to have certain attributes private, ``characteristic`` will keep your kwargs clean if not told otherwise[]:
+
+.. doctest::
+
+   >> @attributes([Attribute("private")])
+   .. class CWithPrivateAttribute(object):
+   ..     pass
+   >> obj8 = CWithPrivateAttribute(private=42)
+   >> obj8._private
+   42
+   >> @attributes([Attribute("private", keep_underscores=False)])
+   .. class CWithPrivateAttributeNoAliasing(object):
+   ..     pass
+   >> obj8 = CWithPrivateAttributeNoAliasing(_private=42)
+   >> obj8._private
+   42