Skip to content

Commit ba7a195

Browse files
committed
docs: add text decration
1 parent 0304689 commit ba7a195

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

user_guide_src/source/helpers/filesystem_helper.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The following functions are available:
2424
.. php:function:: directory_map($sourceDir[, $directoryDepth = 0[, $hidden = false]])
2525
2626
:param string $sourceDir: Path to the source directory
27-
:param int $directoryDepth: Depth of directories to traverse (0 = fully recursive, 1 = current dir, etc)
27+
:param int $directoryDepth: Depth of directories to traverse (``0`` = fully recursive, ``1`` = current dir, etc)
2828
:param bool $hidden: Whether to include hidden paths
2929
:returns: An array of files
3030
:rtype: array
@@ -33,17 +33,17 @@ The following functions are available:
3333

3434
.. literalinclude:: filesystem_helper/002.php
3535

36-
.. note:: Paths are almost always relative to your main index.php file.
36+
.. note:: Paths are almost always relative to your main **index.php** file.
3737

3838
Sub-folders contained within the directory will be mapped as well. If
3939
you wish to control the recursion depth, you can do so using the second
40-
parameter (integer). A depth of 1 will only map the top level directory:
40+
parameter (integer). A depth of ``1`` will only map the top level directory:
4141

4242
.. literalinclude:: filesystem_helper/003.php
4343

4444
By default, hidden files will not be included in the returned array and
4545
hidden directories will be skipped. To override this behavior, you may
46-
set a third parameter to true (boolean):
46+
set a third parameter to ``true`` (boolean):
4747

4848
.. literalinclude:: filesystem_helper/004.php
4949

@@ -99,7 +99,7 @@ The following functions are available:
9999
:param string $path: File path
100100
:param string $data: Data to write to file
101101
:param string $mode: ``fopen()`` mode
102-
:returns: true if the write was successful, false in case of an error
102+
:returns: ``true`` if the write was successful, ``false`` in case of an error
103103
:rtype: bool
104104

105105
Writes data to the file specified in the path. If the file does not exist then the
@@ -120,7 +120,7 @@ The following functions are available:
120120
be set such that it is writable. If the file does not already exist,
121121
then the directory containing it must be writable.
122122

123-
.. note:: The path is relative to your main site index.php file, NOT your
123+
.. note:: The path is relative to your main site **index.php** file, NOT your
124124
controller or view files. CodeIgniter uses a front controller so paths
125125
are always relative to the main site index.
126126

@@ -132,7 +132,7 @@ The following functions are available:
132132
:param bool $delDir: Whether to also delete directories
133133
:param bool $htdocs: Whether to skip deleting .htaccess and index page files
134134
:param bool $hidden: Whether to also delete hidden files (files beginning with a period)
135-
:returns: true on success, false in case of an error
135+
:returns: ``true`` on success, ``false`` in case of an error
136136
:rtype: bool
137137

138138
Deletes ALL files contained in the supplied path.
@@ -141,7 +141,7 @@ The following functions are available:
141141

142142
.. literalinclude:: filesystem_helper/008.php
143143

144-
If the second parameter is set to true, any directories contained within the supplied
144+
If the second parameter is set to ``true``, any directories contained within the supplied
145145
root path will be deleted as well.
146146

147147
Example:

0 commit comments

Comments
 (0)