Add a little bit of example usage to the docs for idl.pl

git-svn-id: svn://svn.open-ils.org/ILS/trunk@8272 dcc99617-32d9-48b4-a31d-7c20da2025e4

diff --git a/Open-ILS/src/python/oils/utils/idl.py b/Open-ILS/src/python/oils/utils/idl.py
index 97ad3de..c918333 100644 (file)
--- a/Open-ILS/src/python/oils/utils/idl.py
+++ b/Open-ILS/src/python/oils/utils/idl.py
@@ -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