Skip to content

Commit ea0a5d2

Browse files
authored
Merge pull request #4042 from totoprayogo1916/update/userguide/e.g.,-i.e.,
[UG] a comma after use: i.e., and e.g.,
2 parents 31f7014 + e45375c commit ea0a5d2

30 files changed

+50
-50
lines changed

user_guide_src/source/cli/cli_generators.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Options:
203203

204204
.. note:: Working on modules? Code generation will set the root namespace to a default of ``APP_NAMESPACE``.
205205
Should you need to have the generated code elsewhere in your module namespace, make sure to set
206-
the ``-n`` option in your command, e.g. ``php spark make:model blog -n Acme\Blog``.
206+
the ``-n`` option in your command, e.g., ``php spark make:model blog -n Acme\Blog``.
207207

208208
.. warning:: Make sure when setting the ``-n`` option that the supplied namespace is a valid namespace
209209
defined in your ``$psr4`` array in ``Config\Autoload`` or defined in your composer autoload file.
@@ -344,12 +344,12 @@ which is public and need not be overridden as it is essentially complete.
344344
``getNamespacedClass`` and ``getTemplate``, or else you will get a PHP fatal error.
345345

346346
.. note:: ``GeneratorCommand`` has the default argument of ``['name' => 'Class name']``. You can
347-
override the description by supplying the name in your ``$arguments`` property, e.g. ``['name' => 'Module class name']``.
347+
override the description by supplying the name in your ``$arguments`` property, e.g., ``['name' => 'Module class name']``.
348348

349349
.. note:: ``GeneratorCommand`` has the default options of ``-n`` and ``--force``. Child classes cannot override
350350
these two properties as they are crucial in the implementation of the code generation.
351351

352352
.. note:: Generators are default listed under the ``Generators`` namespace because it is the default group
353353
name in ``GeneratorCommand``. If you want to have your own generator listed elsewhere under a different
354354
namespace, you will just need to provide the ``$group`` property in your child generator,
355-
e.g. ``protected $group = 'CodeIgniter';``.
355+
e.g., ``protected $group = 'CodeIgniter';``.

user_guide_src/source/concepts/factories.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ anywhere. This is a great way to reuse object states and reduce memory load from
1616
multiple instances loaded across your app.
1717

1818
Anything can be loaded by Factories, but the best examples are those classes that are used
19-
to work on or transmit common data. The framework itself uses Factories internally, e.g. to
19+
to work on or transmit common data. The framework itself uses Factories internally, e.g., to
2020
make sure the correct configuration is loaded when using the ``Config`` class.
2121

2222
Take a look at ``Models`` as an example. You can access the Factory specific to ``Models``

user_guide_src/source/concepts/http.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ is an object-oriented representation of the HTTP request. It provides everything
7474

7575
$request = service('request');
7676

77-
// the URI being requested (i.e. /about)
77+
// the URI being requested (i.e., /about)
7878
$request->uri->getPath();
7979

8080
// Retrieve $_GET and $_POST variables
@@ -100,7 +100,7 @@ is an object-oriented representation of the HTTP request. It provides everything
100100
The request class does a lot of work in the background for you, that you never need to worry about.
101101
The `isAJAX()` and `isSecure()` methods check several different methods to determine the correct answer.
102102

103-
.. 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.
103+
.. 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.
104104

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

user_guide_src/source/database/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ add the config variables as a query string::
6565
// Postgre
6666
$default['DSN'] = 'Postgre://username:password@hostname:5432/database?charset=utf8&connect_timeout=5&sslmode=1';
6767

68-
.. note:: If you provide a DSN string and it is missing some valid settings (e.g. the
68+
.. note:: If you provide a DSN string and it is missing some valid settings (e.g., the
6969
database character set), which are present in the rest of the configuration
7070
fields, CodeIgniter will append them.
7171

user_guide_src/source/database/query_builder.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ searches.
412412

413413
.. note:: All ``like*`` method variations can be forced to perform case-insensitive searches by passing
414414
a fifth parameter of ``true`` to the method. This will use platform-specific features where available
415-
otherwise, will force the values to be lowercase, i.e. ``WHERE LOWER(column) LIKE '%search%'``. This
415+
otherwise, will force the values to be lowercase, i.e., ``WHERE LOWER(column) LIKE '%search%'``. This
416416
may require indexes to be made for ``LOWER(column)`` instead of ``column`` to be effective.
417417

418418
#. **Simple key/value method:**
@@ -609,7 +609,7 @@ searches.
609609

610610
.. note:: All ``havingLike*`` method variations can be forced to perform case-insensitive searches by passing
611611
a fifth parameter of ``true`` to the method. This will use platform-specific features where available
612-
otherwise, will force the values to be lowercase, i.e. ``HAVING LOWER(column) LIKE '%search%'``. This
612+
otherwise, will force the values to be lowercase, i.e., ``HAVING LOWER(column) LIKE '%search%'``. This
613613
may require indexes to be made for ``LOWER(column)`` instead of ``column`` to be effective.
614614

615615
#. **Simple key/value method:**

user_guide_src/source/dbmgmt/migration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Migration file names
2727

2828
Each Migration is run in numeric order forward or backwards depending on the
2929
method taken. Each migration is numbered using the timestamp when the migration
30-
was created, in **YYYYMMDDHHIISS** format (e.g. **20121031100537**). This
30+
was created, in **YYYYMMDDHHIISS** format (e.g., **20121031100537**). This
3131
helps prevent numbering conflicts when working in a team environment.
3232

3333
Prefix your migration files with the migration number followed by an underscore
@@ -306,7 +306,7 @@ Class Reference
306306

307307
.. php:method:: regress($batch, $group)
308308
309-
:param mixed $batch: previous batch to migrate down to; 1+ specifies the batch, 0 reverts all, negative refers to the relative batch (e.g. -3 means "three batches back")
309+
:param mixed $batch: previous batch to migrate down to; 1+ specifies the batch, 0 reverts all, negative refers to the relative batch (e.g., -3 means "three batches back")
310310
:param mixed $group: database group name, if null default database group will be used.
311311
:returns: ``true`` on success, ``false`` on failure or no migrations are found
312312
:rtype: bool

user_guide_src/source/extending/contributing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ If you've found a critical vulnerability, we'd be happy to credit you in our
5151
Tips for a Good Issue Report
5252
****************************
5353

54-
Use a descriptive subject line (eg parser library chokes on commas) rather than a vague one (eg. your code broke).
54+
Use a descriptive subject line (eg parser library chokes on commas) rather than a vague one (e.g., your code broke).
5555

5656
Address a single issue in a report.
5757

58-
Identify the CodeIgniter version (eg 4.0.1) and the component if you know it (eg. parser library)
58+
Identify the CodeIgniter version (eg 4.0.1) and the component if you know it (e.g., parser library)
5959

6060
Explain what you expected to happen, and what did happen.
6161
Include error messages and stack trace, if any.

user_guide_src/source/general/ajax.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
AJAX Requests
33
##############
44

5-
The ``IncomingRequest::isAJAX()`` method uses the ``X-Requested-With`` header to define whether the request is XHR or normal. However, the most recent JavaScript implementations (i.e. fetch) no longer send this header along with the request, thus the use of ``IncomingRequest::isAJAX()`` becomes less reliable, because without this header it is not possible to define whether the request is or not XHR.
5+
The ``IncomingRequest::isAJAX()`` method uses the ``X-Requested-With`` header to define whether the request is XHR or normal. However, the most recent JavaScript implementations (i.e., fetch) no longer send this header along with the request, thus the use of ``IncomingRequest::isAJAX()`` becomes less reliable, because without this header it is not possible to define whether the request is or not XHR.
66

77
To get around this problem, the most efficient solution (so far) is to manually define the request header, forcing the information to be sent to the server, which will then be able to identify that the request is XHR.
88

user_guide_src/source/general/logging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Several core placeholders exist that will be automatically expanded for you base
130130
+----------------+---------------------------------------------------+
131131
| {session_vars} | $_SESSION variables |
132132
+----------------+---------------------------------------------------+
133-
| {env} | Current environment name, i.e. development |
133+
| {env} | Current environment name, i.e., development |
134134
+----------------+---------------------------------------------------+
135135
| {file} | The name of file calling the logger |
136136
+----------------+---------------------------------------------------+

user_guide_src/source/helpers/form_helper.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ The following functions are available:
208208
:param array $data: Field attributes data
209209
:param string $value: Field value
210210
:param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string
211-
:param string $type: The type of input field. i.e. 'text', 'email', 'number', etc.
211+
:param string $type: The type of input field. i.e., 'text', 'email', 'number', etc.
212212
:returns: An HTML text input field tag
213213
:rtype: string
214214

@@ -382,7 +382,7 @@ The following functions are available:
382382

383383
The parameter usage is identical to using :php:func:`form_dropdown()` above,
384384
except of course that the name of the field will need to use POST array
385-
syntax, e.g. foo[].
385+
syntax, e.g., foo[].
386386

387387
.. php:function:: form_fieldset([$legend_text = ''[, $attributes = []]])
388388
@@ -615,7 +615,7 @@ The following functions are available:
615615
second (optional) parameter allows you to set a default value for the
616616
form. The third (optional) parameter allows you to turn off HTML escaping
617617
of the value, in case you need to use this function in combination with
618-
i.e. :php:func:`form_input()` and avoid double-escaping.
618+
i.e., :php:func:`form_input()` and avoid double-escaping.
619619

620620
Example::
621621

0 commit comments

Comments
 (0)