[doc] added an example of use of create_entity in a shell session stable
authorAlexandre Fayolle <alexandre.fayolle@logilab.fr>
Wed, 07 Oct 2009 17:08:49 +0200
branchstable
changeset 3601 d77025be6f06
parent 3600 540210e138d3
child 3604 31cb1070bd43
[doc] added an example of use of create_entity in a shell session
__init__.py
--- a/__init__.py	Wed Oct 07 15:35:59 2009 +0200
+++ b/__init__.py	Wed Oct 07 17:08:49 2009 +0200
@@ -123,7 +123,14 @@
         pass
 
     def create_entity(self, etype, *args, **kwargs):
-        """add a new entity of the given type"""
+        """add a new entity of the given type
+        
+        Example (in a shell session):
+
+        c = create_entity('Company', name='Logilab')
+        create_entity('Person', ('works_for', 'Y'), Y=c.eid, firstname='John', lastname='Doe')
+
+        """
         rql = 'INSERT %s X' % etype
         relations = []
         restrictions = []