Merge pull request #5660 from kenjis/fix-docs-view_renderer.rst

docs: improve view_renderer.rst

Author: kenjis

user_guide_src/source/outgoing/view_renderer.rst

@@ -48,7 +48,7 @@ to you to process the array appropriately in your PHP code.
 Method Chaining
 ===============
 
-The `setVar()` and `setData()` methods are chainable, allowing you to combine a
+The ``setVar()`` and ``setData()`` methods are chainable, allowing you to combine a
 number of different calls together in a chain::
 
     $view->setVar('one', $one)
@@ -62,7 +62,7 @@ When you pass data to the ``setVar()`` and ``setData()`` functions you have the
 against cross-site scripting attacks. As the last parameter in either method, you can pass the desired context to
 escape the data for. See below for context descriptions.
 
-If you don't want the data to be escaped, you can pass `null` or `raw` as the final parameter to each function::
+If you don't want the data to be escaped, you can pass ``null`` or ``'raw'`` as the final parameter to each function::
 
     $view->setVar('one', $one, 'raw');
 
@@ -78,7 +78,7 @@ Escaping Contexts
 By default, the ``esc()`` and, in turn, the ``setVar()`` and ``setData()`` functions assume that the data you want to
 escape is intended to be used within standard HTML. However, if the data is intended for use in Javascript, CSS,
 or in an href attribute, you would need different escaping rules to be effective. You can pass in the name of the
-context as the second parameter. Valid contexts are 'html', 'js', 'css', 'url', and 'attr'::
+context as the second parameter. Valid contexts are ``'html'``, ``'js'``, ``'css'``, ``'url'``, and ``'attr'``::
 
     <a href="<?= esc($url, 'url') ?>" data-foo="<?= esc($bar, 'attr') ?>">Some Link</a>
 
@@ -98,8 +98,7 @@ View Renderer Options
 Several options can be passed to the ``render()`` or ``renderString()`` methods:
 
 -   ``cache`` - the time in seconds, to save a view's results; ignored for renderString()
--   ``cache_name`` - the ID used to save/retrieve a cached view result; defaults to the viewpath;
-        ignored for renderString()
+-   ``cache_name`` - the ID used to save/retrieve a cached view result; defaults to the viewpath; ignored for ``renderString()``
 -   ``saveData`` - true if the view data parameters should be retained for subsequent calls
 
 .. note:: ``saveData`` as defined by the interface must be a boolean, but implementing
@@ -110,7 +109,7 @@ Class Reference
 
 .. php:class:: CodeIgniter\\View\\View
 
-    .. php:method:: render($view[, $options[, $saveData=false]])
+    .. php:method:: render($view[, $options[, $saveData = false]])
         :noindex:
 
         :param  string       $view: File name of the view source
@@ -123,7 +122,7 @@ Class Reference
 
             echo $view->render('myview');
 
-    .. php:method:: renderString($view[, $options[, $saveData=false]])
+    .. php:method:: renderString($view[, $options[, $saveData = false]])
         :noindex:
 
         :param  string       $view: Contents of the view to render, for instance content retrieved from a database
@@ -136,12 +135,12 @@ Class Reference
 
             echo $view->renderString('<div>My Sharona</div>');
 
-        This could be used for displaying content that might have been stored in a database,
+    .. warning:: This could be used for displaying content that might have been stored in a database,
         but you need to be aware that this is a potential security vulnerability,
         and that you **must** validate any such data, and probably escape it
         appropriately!
 
-    .. php:method:: setData([$data[, $context=null]])
+    .. php:method:: setData([$data[, $context = null]])
         :noindex:
 
         :param  array   $data: Array of view data strings, as key/value pairs
@@ -153,13 +152,13 @@ Class Reference
 
             $view->setData(['name'=>'George', 'position'=>'Boss']);
 
-        Supported escape contexts: html, css, js, url, or attr or raw.
-        If 'raw', no escaping will happen.
+        Supported escape contexts: ``html``, ``css``, ``js``, ``url``, or ``attr`` or ``raw``.
+        If ``'raw'``, no escaping will happen.
 
         Each call adds to the array of data that the object is accumulating,
         until the view is rendered.
 
-    .. php:method:: setVar($name[, $value=null[, $context=null]])
+    .. php:method:: setVar($name[, $value = null[, $context = null]])
         :noindex:
 
         :param  string  $name: Name of the view data variable
@@ -172,8 +171,8 @@ Class Reference
 
             $view->setVar('name','Joe','html');
 
-        Supported escape contexts: html, css, js, url, attr or raw.
-        If 'raw', no escaping will happen.
+        Supported escape contexts: ``html``, ``css``, ``js``, ``url``, ``attr`` or ``raw``.
+        If ``'raw'``, no escaping will happen.
 
         If you use the a view data variable that you have previously used
         for this object, the new value will replace the existing one.