Scripts:
[blender.git] / source / blender / python / api2_2x / doc / Sys.py
index 9792d3fd278feabc788bea0f1466da0af8562ebf..47367d86c187e14a0b493a7b19c8fb1e9a8dee6a 100644 (file)
@@ -6,7 +6,7 @@ The Blender.sys submodule.
 sys
 ===
 
-B{New}: L{exists}, L{makename}.
+B{New}: L{exists}, L{makename}, L{join}.
 
 This module provides a minimal set of helper functions and data.  Its purpose
 is to avoid the need for the standard Python module 'os', in special 'os.path',
@@ -59,6 +59,20 @@ def dirname (path):
   @return: the dir name
   """
 
+def join (dir, file):
+  """
+  Join the given dir and file paths, using the proper separator for each
+  platform.
+  @type dir: string
+  @type file: string
+  @param dir: the dir name, like returned from L{dirname}.
+  @param file: the bare filename, like returned from L{basename}.
+  @rtype: string
+  @return: the resulting filename.
+  @warn: this simple function isn't intended to be a complete replacement for
+     the standard os.path.join() one, which handles more general cases.
+  """
+
 def splitext (path):
   """
   Split 'path' into (root, ext), where 'ext' is a file extension.