[pygccxml-commit] SF.net SVN: pygccxml: [903] pyplusplus_dev/docs/documentation/ best_practices.rest

[<rom...@us...>]

Revision: 903
          http://svn.sourceforge.net/pygccxml/?rev=903&view=rev
Author:   roman_yakovenko
Date:     2007-02-11 13:00:32 -0800 (Sun, 11 Feb 2007)

Log Message:
-----------
adding caveats to the documentation

Modified Paths:
--------------
    pyplusplus_dev/docs/documentation/best_practices.rest

Modified: pyplusplus_dev/docs/documentation/best_practices.rest
===================================================================
--- pyplusplus_dev/docs/documentation/best_practices.rest	2007-02-11 20:59:49 UTC (rev 902)
+++ pyplusplus_dev/docs/documentation/best_practices.rest	2007-02-11 21:00:32 UTC (rev 903)
@@ -84,7 +84,30 @@
     my_big_class = mb.class_( my_big_class )
     mb.split_module( ..., huge_classes=[my_big_class], ... )
 
+  * **Caveats**
+   
+    Consider next file layout:
+    ::
 
+      boost/
+        date_time/
+          ptime.hpp
+          time_duration.hpp
+          date_time.hpp //main header, which include all other header files
+
+    Py++ currently does not handle relative paths as input very well, so it is 
+    recommended that you use "os.path.abspath()" to transform the header file to 
+    be processed into an absolute path:
+    
+    .. code-block:: Python
+    
+      #Next code will expose nothing
+      mb = module_builder( [ 'date_time/date_time.hpp' ], ... ) 
+
+      #while this one will work as expected
+      import os
+      mb = module_builder( [ os.path.abspath('date_time/date_time.hpp') ], ... ) 
+
 .. _`this error` : http://boost.org/libs/python/doc/v2/faq.html#c1204
 .. __ : ./../../pygccxml/design.html
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.