docs: Fix typos and add missing preferences in libraries/email.rst by obozdag · Pull Request #8851 · codeigniter4/CodeIgniter4

obozdag · 2024-05-04T14:36:56Z

Description
Fix typos and add missing preferences in libraries/email.rst

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

Fix typos and add missing preferences in libraries/email.rst

user_guide_src/source/libraries/email.rst

obozdag · 2024-06-10T08:26:41Z

@kenjis What kind of rework does it need? Should I remove $recipients or $ marks or both?

kenjis · 2024-06-10T08:32:23Z

@obozdag Yes.

Remove recipients from preferences list in libraries/email.rst

user_guide_src/source/libraries/email.rst

kenjis

Please remove all $ marks in Preference.
Because these items may be keys in an array.

Remove $ marks in Preference in libraries/email.rst

obozdag · 2024-07-24T03:24:42Z

@kenjis I have removed all $ marks in Preference.
In https://codeigniter4.github.io/CodeIgniter4/libraries/cookies.html#cookie-personalization there are $ marks and they can be keys in the defaults array. So, shall I also remove the $ marks there?

kenjis · 2024-07-24T04:13:07Z

@obozdag Thank you!

In https://codeigniter4.github.io/CodeIgniter4/libraries/cookies.html#cookie-personalization there are $ marks and they can be keys in the defaults array. So, shall I also remove the $ marks there?

I'm not sure. Because the description for the table is:

However, you may wish to define your own settings by changing the following settings in the Config\Cookie class in app/Config/Cookie.php file.

So it clearly indicates that the table explains properties in Config\Cookie.
But yes, the items are also array keys for Cookie::setDefaults().

paulbalandan · 2024-07-24T04:48:28Z

I think I mean here when I made the table is it is referring to the properties of Config\Cookie so the $ should be preserved. The array keys to Cookie::$defaults are private implementation details.

kenjis · 2024-07-25T01:05:30Z

@obozdag Thank you!

docs: Fix typos and add missing preferences in libraries/email.rst

9acc52d

Fix typos and add missing preferences in libraries/email.rst

kenjis added the documentation Pull requests for documentation only label May 5, 2024

kenjis reviewed May 5, 2024

View reviewed changes