# HG changeset patch
# User Thinker K.F. Li <thinker@codemud.net>
# Date 1297511218 -28800
# Node ID b0e54ae756f8c2027aaa185c49b8630ec4700790
# Parent  22a79dcbaec647484272dc7235989f6c652bd504
More doc

diff -r 22a79dcbaec6 -r b0e54ae756f8 pyink/trait.py
--- a/pyink/trait.py	Sat Feb 12 19:22:21 2011 +0800
+++ b/pyink/trait.py	Sat Feb 12 19:46:58 2011 +0800
@@ -262,6 +262,35 @@
 # dictionary mapping from require attributes of used traits to names
 # of attributes of the composition class.
 #
+# \verbatim
+# @composite
+# class foo(object):
+#     use_trait = (trait_a, trait_b)
+#     provide_traits = {trait_a.var_a: 'var_foo'}
+#
+#     var_foo = 'value of var_foo'
+#     pass
+# \endverbatim
+#
+# Like mapping require attributes of used traits, there is a map,
+# named method_map_traits, for methods of used traits.
+#
+# \verbatim
+# @composite
+# class foo(object):
+#     use_trait = (trait_a, trait_b)
+#     provide_traits = {trait_a.var_a: 'var_foo'}
+#     method_map_traits = {trait_a.xxx: 'hello')
+#
+#     var_foo = 'value of var_foo'
+#     pass
+# \endverbatim
+#
+# Previous example maps trait_a.xxx method to foo.hello method.
+# composite does not include methods that has a name prefixed by a '_'
+# charater.  But, you can still force it, by an explicity mapping in
+# method_map_traits, to include a method prefixed by a '_' character.
+#
 def composite(clazz):
     if not hasattr(clazz, 'use_traits'):
         raise KeyError, \