[open-ils-commits] r8272 - trunk/Open-ILS/src/python/oils/utils

[svn at svn.open-ils.org]

Author: dbs
Date: 2007-12-21 13:42:39 -0500 (Fri, 21 Dec 2007)
New Revision: 8272

Modified:
   trunk/Open-ILS/src/python/oils/utils/idl.py
Log:
Add a little bit of example usage to the docs for idl.pl


Modified: trunk/Open-ILS/src/python/oils/utils/idl.py
===================================================================
--- trunk/Open-ILS/src/python/oils/utils/idl.py	2007-12-21 18:13:21 UTC (rev 8271)
+++ trunk/Open-ILS/src/python/oils/utils/idl.py	2007-12-21 18:42:39 UTC (rev 8272)
@@ -1,3 +1,17 @@
+"""
+Parses an Evergreen fieldmapper IDL file and builds a global registry of
+objects representing that IDL.
+
+Typical usage:
+
+>>> import osrf.system
+>>> import oils.utils.idl
+>>> osrf.system.connect('/openils/conf/opensrf_core.xml', 'config.opensrf')
+>>> oils.utils.idl.oilsParseIDL()
+>>> # 'bre' is a network registry hint, or class ID in the IDL file
+... print oils.utils.idl.oilsGetIDLParser().IDLObject['bre']['tablename']
+biblio.record_entry
+"""
 import osrf.net_obj
 import osrf.log
 import osrf.set