diff options
| author | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
| commit | 3de130c2da3b93a3404f264e92d7b65354de3548 (patch) | |
| tree | 368b1847fffe7af21c5fbc3fa7925212b678e60b /user_guide_src/source/helpers/path_helper.rst | |
| parent | 1e584208e420d1d864de2bc686d437ecdf0ce064 (diff) | |
[ci skip] Add return types to helper docs (+ some other formatting)
Diffstat (limited to 'user_guide_src/source/helpers/path_helper.rst')
| -rw-r--r-- | user_guide_src/source/helpers/path_helper.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst index 61877d75b..705ca23b9 100644 --- a/user_guide_src/source/helpers/path_helper.rst +++ b/user_guide_src/source/helpers/path_helper.rst @@ -29,7 +29,8 @@ The following functions are available: :param string $path: Path :param bool $check_existance: Whether to check if the path actually exists - :returns: string + :returns: An absolute path + :rtype: string This function will return a server path without symbolic links or relative directory structures. An optional second argument will |