BGE: Updating the bge.logic.expandPath() documentation to better reflect its current behavior.

This commit is contained in:
Mitchell Stokes 2013-08-13 07:48:07 +00:00
parent 5b64b66127
commit 851627f6e0
2 changed files with 5 additions and 6 deletions

@ -362,9 +362,9 @@ Utility functions
Use / as directory separator in path
You can use '//' at the start of the string to define a relative path;
Blender replaces that string by the directory of the startup .blend or runtime file
to make a full path name (doesn't change during the game, even if you load other .blend).
The function also converts the directory separator to the local file system format.
Blender replaces that string by the directory of the current .blend or runtime file
to make a full path name. The function also converts the directory separator to
the local file system format.
:arg path: The path string to be converted/expanded.
:type path: string

@ -233,9 +233,8 @@ static char gPyExpandPath_doc[] =
path - the string path to convert.\n\n\
Use / as directory separator in path\n\
You can use '//' at the start of the string to define a relative path;\n\
Blender replaces that string by the directory of the startup .blend or runtime\n\
file to make a full path name (doesn't change during the game, even if you load\n\
other .blend).\n\
Blender replaces that string by the directory of the current .blend or runtime\n\
file to make a full path name.\n\
The function also converts the directory separator to the local file system format.";
static PyObject *gPyExpandPath(PyObject *, PyObject *args)