Skip to content

Commit b9bfb99

Browse files
authored
Merge pull request #2611 from LittleJ/ci-4.0.1-fix-sphinx-warnings
[UG] Fix all Sphinx warnings
2 parents 8b48b8a + 7f6ff52 commit b9bfb99

5 files changed

Lines changed: 13 additions & 19 deletions

File tree

user_guide_src/source/concepts/http.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,6 @@ The `isAJAX()` and `isSecure()` methods check several different methods to deter
9999

100100
.. note:: The ``isAJAX()`` method depends on the ``X-Requested-With`` header, which in some cases is not sent by default in XHR requests via JavaScript (i.e. fetch). See the :doc:`AJAX Requests </general/ajax>` section on how to avoid this problem.
101101

102-
::
103-
104102
CodeIgniter also provides a :doc:`Response class </outgoing/response>` that is an object-oriented representation
105103
of the HTTP response. This gives you an easy and powerful way to construct your response to the client::
106104

user_guide_src/source/incoming/filters.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,6 @@ would apply to every AJAX request.
168168

169169
.. note:: The AJAX requests depends on the ``X-Requested-With`` header, which in some cases is not sent by default in XHR requests via JavaScript (i.e. fetch). See the :doc:`AJAX Requests </general/ajax>` section on how to avoid this problem.
170170

171-
::
172-
173171
$filters
174172
========
175173

user_guide_src/source/incoming/incomingrequest.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ get a copy of it through the :doc:`Services class </concepts/services>`::
3838
It's preferable, though, to pass the request in as a dependency if the class is anything other than
3939
the controller, where you can save it as a class property::
4040

41-
<?php
41+
<?php
4242
use CodeIgniter\HTTP\RequestInterface;
4343

4444
class SomeClass
@@ -73,8 +73,6 @@ be checked with the ``isAJAX()`` and ``isCLI()`` methods::
7373

7474
.. note:: The ``isAJAX()`` method depends on the ``X-Requested-With`` header, which in some cases is not sent by default in XHR requests via JavaScript (i.e. fetch). See the :doc:`AJAX Requests </general/ajax>` section on how to avoid this problem.
7575

76-
::
77-
7876
You can check the HTTP method that this request represents with the ``method()`` method::
7977

8078
// Returns 'post'
@@ -261,7 +259,7 @@ You can retrieve a single file uploaded on its own, based on the filename given
261259

262260
$file = $request->getFile('uploadedfile');
263261

264-
You can retrieve an array of same-named files uploaded as part of a
262+
You can retrieve an array of same-named files uploaded as part of a
265263
multi-file upload, based on the filename given in the HTML file input::
266264

267265
$files = $request->getFileMultiple('uploadedfile');

user_guide_src/source/libraries/caching.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ The settings for the Redis server that you wish to use when using the ``Redis``
7575
Class Reference
7676
***************
7777

78-
.. php:method:: isSupported()
78+
.. php:method:: isSupported()
7979
8080
:returns: TRUE if supported, FALSE if not
8181
:rtype: bool
8282

83-
.. php:method:: get($key)
83+
.. php:method:: get($key)
8484
8585
:param string $key: Cache item name
8686
:returns: Item value or NULL if not found
@@ -93,7 +93,7 @@ Class Reference
9393

9494
$foo = $cache->get('my_cached_item');
9595

96-
.. php:method:: save($key, $data[, $ttl = 60[, $raw = FALSE]])
96+
.. php:method:: save($key, $data[, $ttl = 60[, $raw = FALSE]])
9797
9898
:param string $key: Cache item name
9999
:param mixed $data: the data to save
@@ -112,7 +112,7 @@ Class Reference
112112
.. note:: The ``$raw`` parameter is only utilized by Memcache,
113113
in order to allow usage of ``increment()`` and ``decrement()``.
114114

115-
.. php:method:: delete($key)
115+
.. php:method:: delete($key)
116116
117117
:param string $key: name of cached item
118118
:returns: TRUE on success, FALSE on failure
@@ -125,7 +125,7 @@ Class Reference
125125

126126
$cache->delete('cache_item_id');
127127

128-
.. php:method:: increment($key[, $offset = 1])
128+
.. php:method:: increment($key[, $offset = 1])
129129
130130
:param string $key: Cache ID
131131
:param int $offset: Step/value to add
@@ -142,7 +142,7 @@ Class Reference
142142

143143
$cache->increment('iterator', 3); // 'iterator' is now 6
144144

145-
.. php:method:: decrement($key[, $offset = 1])
145+
.. php:method:: decrement($key[, $offset = 1])
146146
147147
:param string $key: Cache ID
148148
:param int $offset: Step/value to reduce by
@@ -159,7 +159,7 @@ Class Reference
159159

160160
$cache->decrement('iterator', 2); // 'iterator' is now 3
161161

162-
.. php:method:: clean()
162+
.. php:method:: clean()
163163
164164
:returns: TRUE on success, FALSE on failure
165165
:rtype: bool
@@ -171,7 +171,7 @@ Class Reference
171171

172172
$cache->clean();
173173

174-
.. php:method:: cache_info()
174+
.. php:method:: cache_info()
175175
176176
:returns: Information on the entire cache database
177177
:rtype: mixed
@@ -185,7 +185,7 @@ Class Reference
185185
.. note:: The information returned and the structure of the data is dependent
186186
on which adapter is being used.
187187

188-
.. php:method:: getMetadata($key)
188+
.. php:method:: getMetadata($key)
189189
190190
:param string $key: Cache item name
191191
:returns: Metadata for the cached item

user_guide_src/source/testing/overview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ helper methods to make testing every aspect of your application as painless as p
1010
:local:
1111
:depth: 2
1212

13-
************
13+
*************
1414
System Set Up
15-
************
15+
*************
1616

1717
Installing phpUnit
1818
==================

0 commit comments

Comments
 (0)