From bfa124a27264ee11abf3777a72b12bb0ad0d36a2 Mon Sep 17 00:00:00 2001 From: Little J Date: Mon, 24 Feb 2020 21:06:10 +0100 Subject: [PATCH 1/5] [UG] Fix typo causing Sphinx warning "Inconsistent block quoting" --- user_guide_src/source/incoming/filters.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/user_guide_src/source/incoming/filters.rst b/user_guide_src/source/incoming/filters.rst index 7c22ff0521..32e0fd134b 100644 --- a/user_guide_src/source/incoming/filters.rst +++ b/user_guide_src/source/incoming/filters.rst @@ -168,8 +168,6 @@ would apply to every AJAX request. .. 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 ` section on how to avoid this problem. -:: - $filters ======== From b14a436c9a880c7485708ff741ac443bc58a48cf Mon Sep 17 00:00:00 2001 From: Little J Date: Mon, 24 Feb 2020 21:08:50 +0100 Subject: [PATCH 2/5] [UG] Fix typo causing Sphinx warning "Literal block expected" --- user_guide_src/source/incoming/incomingrequest.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/user_guide_src/source/incoming/incomingrequest.rst b/user_guide_src/source/incoming/incomingrequest.rst index f7339e836b..de223d812e 100644 --- a/user_guide_src/source/incoming/incomingrequest.rst +++ b/user_guide_src/source/incoming/incomingrequest.rst @@ -38,7 +38,7 @@ get a copy of it through the :doc:`Services class `:: It's preferable, though, to pass the request in as a dependency if the class is anything other than the controller, where you can save it as a class property:: - ` section on how to avoid this problem. -:: - You can check the HTTP method that this request represents with the ``method()`` method:: // Returns 'post' @@ -261,7 +259,7 @@ You can retrieve a single file uploaded on its own, based on the filename given $file = $request->getFile('uploadedfile'); -You can retrieve an array of same-named files uploaded as part of a +You can retrieve an array of same-named files uploaded as part of a multi-file upload, based on the filename given in the HTML file input:: $files = $request->getFileMultiple('uploadedfile'); From b890d67d553d56c2b7464fafa029bf7eacbd4788 Mon Sep 17 00:00:00 2001 From: Little J Date: Mon, 24 Feb 2020 21:10:21 +0100 Subject: [PATCH 3/5] [UG] Fix typo causing Sphinx warning "Title overline too short" --- user_guide_src/source/testing/overview.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user_guide_src/source/testing/overview.rst b/user_guide_src/source/testing/overview.rst index 5201a1538d..55794be7d1 100644 --- a/user_guide_src/source/testing/overview.rst +++ b/user_guide_src/source/testing/overview.rst @@ -10,9 +10,9 @@ helper methods to make testing every aspect of your application as painless as p :local: :depth: 2 -************ +************* System Set Up -************ +************* Installing phpUnit ================== From 695c0466e9c61c83e1e586eac2f635f11e6e39f7 Mon Sep 17 00:00:00 2001 From: Little J Date: Mon, 24 Feb 2020 21:12:00 +0100 Subject: [PATCH 4/5] [UG] Fix typo causing Sphinx warning "Literal block expected" --- user_guide_src/source/concepts/http.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/user_guide_src/source/concepts/http.rst b/user_guide_src/source/concepts/http.rst index 3e8d1ddb60..81c8277047 100644 --- a/user_guide_src/source/concepts/http.rst +++ b/user_guide_src/source/concepts/http.rst @@ -99,8 +99,6 @@ The `isAJAX()` and `isSecure()` methods check several different methods to deter .. 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 ` section on how to avoid this problem. -:: - CodeIgniter also provides a :doc:`Response class ` that is an object-oriented representation of the HTTP response. This gives you an easy and powerful way to construct your response to the client:: From 7f6ff52135bf72a84bff51706bbfe7b4e184db44 Mon Sep 17 00:00:00 2001 From: Little J Date: Mon, 24 Feb 2020 21:45:34 +0100 Subject: [PATCH 5/5] [UG] Add spaces to remove 4 "duplicate object description" warnings --- user_guide_src/source/libraries/caching.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst index 3629b077fb..9f270b0a88 100644 --- a/user_guide_src/source/libraries/caching.rst +++ b/user_guide_src/source/libraries/caching.rst @@ -75,12 +75,12 @@ The settings for the Redis server that you wish to use when using the ``Redis`` Class Reference *************** -.. php:method:: isSupported() +.. php:method:: ⠀isSupported() :returns: TRUE if supported, FALSE if not :rtype: bool -.. php:method:: get($key) +.. php:method:: ⠀get($key) :param string $key: Cache item name :returns: Item value or NULL if not found @@ -93,7 +93,7 @@ Class Reference $foo = $cache->get('my_cached_item'); -.. php:method:: save($key, $data[, $ttl = 60[, $raw = FALSE]]) +.. php:method:: ⠀save($key, $data[, $ttl = 60[, $raw = FALSE]]) :param string $key: Cache item name :param mixed $data: the data to save @@ -112,7 +112,7 @@ Class Reference .. note:: The ``$raw`` parameter is only utilized by Memcache, in order to allow usage of ``increment()`` and ``decrement()``. -.. php:method:: delete($key) +.. php:method:: ⠀delete($key) :param string $key: name of cached item :returns: TRUE on success, FALSE on failure @@ -125,7 +125,7 @@ Class Reference $cache->delete('cache_item_id'); -.. php:method:: increment($key[, $offset = 1]) +.. php:method:: ⠀increment($key[, $offset = 1]) :param string $key: Cache ID :param int $offset: Step/value to add @@ -142,7 +142,7 @@ Class Reference $cache->increment('iterator', 3); // 'iterator' is now 6 -.. php:method:: decrement($key[, $offset = 1]) +.. php:method:: ⠀decrement($key[, $offset = 1]) :param string $key: Cache ID :param int $offset: Step/value to reduce by @@ -159,7 +159,7 @@ Class Reference $cache->decrement('iterator', 2); // 'iterator' is now 3 -.. php:method:: clean() +.. php:method:: ⠀clean() :returns: TRUE on success, FALSE on failure :rtype: bool @@ -171,7 +171,7 @@ Class Reference $cache->clean(); -.. php:method:: cache_info() +.. php:method:: ⠀cache_info() :returns: Information on the entire cache database :rtype: mixed @@ -185,7 +185,7 @@ Class Reference .. note:: The information returned and the structure of the data is dependent on which adapter is being used. -.. php:method:: getMetadata($key) +.. php:method:: ⠀getMetadata($key) :param string $key: Cache item name :returns: Metadata for the cached item