From 464ebb80b70577f8a0098b8935f95aca81ba9c05 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 5 Feb 2024 15:23:29 +0900 Subject: [PATCH 1/7] docs: update @var type --- app/Config/App.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/Config/App.php b/app/Config/App.php index 6ae678625e7b..c2ac69fcccd1 100644 --- a/app/Config/App.php +++ b/app/Config/App.php @@ -94,7 +94,7 @@ class App extends BaseConfig * * IncomingRequest::setLocale() also uses this list. * - * @var string[] + * @var list */ public array $supportedLocales = ['en']; From 857e14ee2e793c98bd731545c6d3d588cad19714 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 5 Feb 2024 15:23:57 +0900 Subject: [PATCH 2/7] docs: add "E.g.," --- app/Config/App.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/Config/App.php b/app/Config/App.php index c2ac69fcccd1..34f19813563e 100644 --- a/app/Config/App.php +++ b/app/Config/App.php @@ -14,7 +14,7 @@ class App extends BaseConfig * URL to your CodeIgniter root. Typically, this will be your base URL, * WITH a trailing slash: * - * http://example.com/ + * E.g., http://example.com/ */ public string $baseURL = 'http://localhost:8080/'; From 1bbb26c003f881cb078a823a0c489f05dd3ca9c4 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 5 Feb 2024 15:24:52 +0900 Subject: [PATCH 3/7] docs: add "," --- app/Config/App.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/Config/App.php b/app/Config/App.php index 34f19813563e..1afe256ad323 100644 --- a/app/Config/App.php +++ b/app/Config/App.php @@ -36,9 +36,9 @@ class App extends BaseConfig * Index File * -------------------------------------------------------------------------- * - * Typically this will be your index.php file, unless you've renamed it to - * something else. If you are using mod_rewrite to remove the page set this - * variable so that it is blank. + * Typically, this will be your `index.php` file, unless you've renamed it to + * something else. If you have configured your web server to remove this file + * from your site URIs, set this variable to an empty string. */ public string $indexPage = 'index.php'; From 4c03c9355f9ad0b74933944502f2ad7b30c32664 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 5 Feb 2024 15:25:23 +0900 Subject: [PATCH 4/7] docs: break long lines --- app/Config/App.php | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/app/Config/App.php b/app/Config/App.php index 1afe256ad323..3d7b971ab89f 100644 --- a/app/Config/App.php +++ b/app/Config/App.php @@ -22,10 +22,10 @@ class App extends BaseConfig * Allowed Hostnames in the Site URL other than the hostname in the baseURL. * If you want to accept multiple Hostnames, set this. * - * E.g. When your site URL ($baseURL) is 'http://example.com/', and your site - * also accepts 'http://media.example.com/' and - * 'http://accounts.example.com/': - * ['media.example.com', 'accounts.example.com'] + * E.g., + * When your site URL ($baseURL) is 'http://example.com/', and your site + * also accepts 'http://media.example.com/' and 'http://accounts.example.com/': + * ['media.example.com', 'accounts.example.com'] * * @var list */ @@ -106,7 +106,8 @@ class App extends BaseConfig * The default timezone that will be used in your application to display * dates with the date helper, and can be retrieved through app_timezone() * - * @see https://www.php.net/manual/en/timezones.php for list of timezones supported by PHP. + * @see https://www.php.net/manual/en/timezones.php for list of timezones + * supported by PHP. */ public string $appTimezone = 'UTC'; From e32d1d2f44fad1b737d6157192ce31fa84127503 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 5 Feb 2024 15:25:43 +0900 Subject: [PATCH 5/7] docs: remove duplicate space --- app/Config/App.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/Config/App.php b/app/Config/App.php index 3d7b971ab89f..8883d061f05f 100644 --- a/app/Config/App.php +++ b/app/Config/App.php @@ -48,7 +48,7 @@ class App extends BaseConfig * -------------------------------------------------------------------------- * * This item determines which server global should be used to retrieve the - * URI string. The default setting of 'REQUEST_URI' works for most servers. + * URI string. The default setting of 'REQUEST_URI' works for most servers. * If your links do not seem to work, try one of the other delicious flavors: * * 'REQUEST_URI' Uses $_SERVER['REQUEST_URI'] From 61bf6fd8c3069feed384a61c509bee0ad82c5812 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 5 Feb 2024 15:26:03 +0900 Subject: [PATCH 6/7] docs: add keyword "HSTS" --- app/Config/App.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/Config/App.php b/app/Config/App.php index 8883d061f05f..1a359ed3a49e 100644 --- a/app/Config/App.php +++ b/app/Config/App.php @@ -131,7 +131,7 @@ class App extends BaseConfig * If true, this will force every request made to this application to be * made via a secure connection (HTTPS). If the incoming request is not * secure, the user will be redirected to a secure version of the page - * and the HTTP Strict Transport Security header will be set. + * and the HTTP Strict Transport Security (HSTS) header will be set. */ public bool $forceGlobalSecureRequests = false; From bf1057ee5c7ef8e47500a945bebc87b3b2898d0d Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 5 Feb 2024 15:27:44 +0900 Subject: [PATCH 7/7] docs: improve readability --- app/Config/App.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/Config/App.php b/app/Config/App.php index 1a359ed3a49e..21b4df205286 100644 --- a/app/Config/App.php +++ b/app/Config/App.php @@ -51,9 +51,9 @@ class App extends BaseConfig * URI string. The default setting of 'REQUEST_URI' works for most servers. * If your links do not seem to work, try one of the other delicious flavors: * - * 'REQUEST_URI' Uses $_SERVER['REQUEST_URI'] - * 'QUERY_STRING' Uses $_SERVER['QUERY_STRING'] - * 'PATH_INFO' Uses $_SERVER['PATH_INFO'] + * 'REQUEST_URI': Uses $_SERVER['REQUEST_URI'] + * 'QUERY_STRING': Uses $_SERVER['QUERY_STRING'] + * 'PATH_INFO': Uses $_SERVER['PATH_INFO'] * * WARNING: If you set this to 'PATH_INFO', URIs will always be URL-decoded! */