Skip to content

Commit 750b602

Browse files
committed
Cleanup typos
1 parent 117653c commit 750b602

10 files changed

Lines changed: 29 additions & 43 deletions

File tree

user_guide_src/source/concepts/http.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ how to work with the requests and responses within CodeIgniter.
1212
What is HTTP?
1313
=============
1414

15-
HTTP is simply a text-based language that allows two machines to talk to each other. When a browser
15+
HTTP is simply a text-based convention that allows two machines to talk to each other. When a browser
1616
requests a page, it asks the server if it can get the page. The server then prepares the page and sends
17-
response back to the browser that asked for it. That's pretty much it. Obviously, there are some complexities
17+
a response back to the browser that asked for it. That's pretty much it. Obviously, there are some complexities
1818
that you can use, but the basics are really pretty simple.
1919

20-
HTTP is the term used to describe that language. It stands for HyperText Transfer Protocol. Your goal when
20+
HTTP is the term used to describe that exchange convention. It stands for HyperText Transfer Protocol. Your goal when
2121
you develop web applications is to always understand what the browser is requesting, and be able to
2222
respond appropriately.
2323

2424
The Request
2525
-----------
26-
Whenever a client makes a request (a web browser, smartphone app, etc), it is sending a small text message
26+
Whenever a client (a web browser, smartphone app, etc) makes a request, it sends a small text message
2727
to the server and waits for a response.
2828

2929
The request would look something like this::
@@ -67,7 +67,7 @@ Working with Requests and Responses
6767
-----------------------------------
6868

6969
While PHP provides ways to interact with the request and response headers, CodeIgniter, like most frameworks,
70-
abstract them so that you have a consistent, simple interface to them. The :doc:`IncomingRequest class </libraries/incomingrequest>`
70+
abstracts them so that you have a consistent, simple interface to them. The :doc:`IncomingRequest class </libraries/incomingrequest>`
7171
is an object-oriented representation of the HTTP request. It provides everything you need::
7272

7373
use CodeIgniter\HTTP\IncomingRequest;

user_guide_src/source/concepts/mvc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ then determine what to do with it. This often involves passing the data to a mod
7373
the model that is then passed on to the view to be displayed. This also includes loading up other utility classes,
7474
if needed, to handle specialized tasks that is outside of the purview of the model.
7575

76-
The other responsibility of the controller is to handles everything that pertains to HTTP requests - redirects,
76+
The other responsibility of the controller is to handle everything that pertains to HTTP requests - redirects,
7777
authentication, web safety, encoding, etc. In short, the controller is where you make sure that people are allowed to
7878
be there, and they get the data they need in a format they can use.
7979

8080
Controllers are typically stored in **/application/Controllers**, though they can use a namespace to be grouped however
8181
you need.
8282

83-
:doc:`Find out more about controllers </general/controllers>`
83+
:doc:`Find out more about controllers </general/controllers>`

user_guide_src/source/concepts/structure.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,11 @@ production servers.
7474

7575
docs
7676
----
77-
This directory holds the CodeIgniter documentation. The ``user_guide`` subfolder contains a local copy of the
78-
User Guide, and the ``api_docs`` subfolder contains a local copy of the CodeIgniter components API reference.
77+
This directory holds a local copy of the CodeIgniter4
78+
User Guide.
7979

8080
Modifying Directory Locations
8181
-----------------------------
8282

83-
If you've relocated any of the main directories, you can let the application
84-
know the new location within the main ``index.php`` file.
85-
86-
Starting around line 50, you will find three variables that hold the location to the **application**,
87-
**system**, and **writable** directories. These paths are relative to **index.php**.
83+
If you've relocated any of the main directories, you can change the configuration
84+
settings inside ``application/Config/Paths``.

user_guide_src/source/general/cli.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
###################
2-
Running via the CLI
3-
###################
1+
############################
2+
Running via the Command Line
3+
############################
44

55
As well as calling an applications :doc:`Controllers <./controllers>`
66
via the URL in a browser they can also be loaded via the command-line

user_guide_src/source/general/configuration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ you will have settings that might change depending on the server it's running on
6868
database settings, API credentials, and other settings that will vary between deploys.
6969

7070
You can store values in a **.env** file in the root directory, alongside the system and application directories.
71-
It is simply a collection of name/value pairs separated by an equal sign, much like a .ini file::
71+
It is simply a collection of name/value pairs separated by an equal sign, much like a ".ini" file::
7272

7373
S3_BUCKET="dotenv"
7474
SECRET_KEY="super_secret_key"
@@ -104,7 +104,7 @@ variable name within ``${...}``::
104104
Namespaced Variables
105105
====================
106106

107-
There will be times when you will have several variables of the same name. When this happens, the
107+
There will be times when you will have several variables with the same name. When this happens, the
108108
system has no way of knowing what the correct value should be. You can protect against this by
109109
"namespacing" the variables.
110110

user_guide_src/source/general/filters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,4 +177,4 @@ a list of URI patterns that filter should apply to::
177177
Provided Filters
178178
================
179179

180-
To be determined.
180+
Three filters are bundled with CodeIgniter4: Honeypot, Security, and Throttler.

user_guide_src/source/general/managing_apps.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Managing your Applications
33
##########################
44

55
By default it is assumed that you only intend to use CodeIgniter to
6-
manage one application, which you will build in your **application/**
6+
manage one application, which you will build in your **application**
77
directory. It is possible, however, to have multiple sets of
88
applications that share a single CodeIgniter installation, or even to
99
rename or relocate your application directory.
@@ -12,7 +12,7 @@ Renaming the Application Directory
1212
==================================
1313

1414
If you would like to rename your application directory you may do so
15-
as long as you open your main **index.php** file and set its name using
15+
as long as you open **application/Config/Paths.php** file and set its name using
1616
the ``$application_directory`` variable::
1717

1818
$application_directory = 'application';

user_guide_src/source/libraries/localization.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ language codes like en-US for American English, or fr-FR, for French/France. A m
3939
to this can be found on the `W3C's site <https://www.w3.org/International/articles/language-tags/>`_.
4040

4141
The system is smart enough to fallback to more generic language codes if an exact match
42-
cannot be found. If the locale code was set to **en_US** and we only have language files setup for **en**
43-
then those will be used since nothing exists for the more specific **en_US**. If, however, a language
44-
directory existed at **application/Language/en_US** then that we be used first.
42+
cannot be found. If the locale code was set to **en-US** and we only have language files setup for **en**
43+
then those will be used since nothing exists for the more specific **en-US**. If, however, a language
44+
directory existed at **application/Language/en-US** then that would be used first.
4545

4646
Locale Detection
4747
================
@@ -64,7 +64,7 @@ of locales that you have defined in ``$supportLocales``. If no match is found be
6464
that you support, and the requested language, the first item in $supportedLocales will be used. In
6565
the following example, the **en** locale would be used if no match is found::
6666

67-
public $supportedLocales = ['en', 'es', 'fr_FR'];
67+
public $supportedLocales = ['en', 'es', 'fr-FR'];
6868

6969
In Routes
7070
---------
@@ -108,7 +108,7 @@ Language Localization
108108
Creating Language Files
109109
=======================
110110

111-
Language do not have any specific naming convention that are required. The file should be named logically to
111+
Languages do not have any specific naming convention that are required. The file should be named logically to
112112
describe the type of content it holds. For example, let's say you want to create a file containing error messages.
113113
You might name it simply: **Errors.php**.
114114

@@ -234,12 +234,12 @@ third parameter to the ``lang()`` method.
234234
::
235235

236236
// Displays "The time is now 23:21:28 GMT-5"
237-
echo lang('Test.longTime', [time()], 'ru_RU');
237+
echo lang('Test.longTime', [time()], 'ru-RU');
238238

239239
// Displays "£7.41"
240-
echo lang('{price, number, currency}', ['price' => 7.41], 'en_GB');
240+
echo lang('{price, number, currency}', ['price' => 7.41], 'en-GB');
241241
// Displays "$7.41"
242-
echo lang('{price, number, currency}', ['price' => 7.41], 'en_US');
242+
echo lang('{price, number, currency}', ['price' => 7.41], 'en-US');
243243

244244
Nested Arrays
245245
-------------

user_guide_src/source/libraries/typography.rst

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

5-
The Typography libary contains methods that help your format text
5+
The Typography libary contains methods that help you format text
66
in semantically relevant ways.
77

88
*******************

user_guide_src/source/testing/overview.rst

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,6 @@ The other option is to download the .phar file from the `phpUnit <https://phpuni
4444
This is standalone file that should be placed within your project root.
4545

4646

47-
phpunit.xml
48-
===========
49-
50-
A basic configuration for phpUnit has already been defined in ``phpunit.xml.dist``. Any project-specific changes to
51-
this file should be done in a separate file so that it doesn't get overwritten by any framework updates. Copying the file
52-
to ``phpunit.xml`` will create a file that phpUnit will use instead of the original file.
53-
54-
5547
************************
5648
Testing Your Application
5749
************************
@@ -205,10 +197,7 @@ Removes all mocked classes from the Services class, bringing it back to its orig
205197
Stream Filters
206198
==============
207199

208-
Some stream filters have been provided as an alternate to these helper methods.
209-
210-
CITestStreamFilter
211-
------------------
200+
**CITestStreamFilter** provides an alternate to these helper methods.
212201

213202
You may need to test things that are difficult to test. Sometimes, capturing a stream, like PHP's own STDOUT, or STDERR,
214203
might be helpful. The ``CITestStreamFilter`` helps you capture the output from the stream of your choice.

0 commit comments

Comments
 (0)