+- CodeIgniter Forums (https://forum.codeigniter.com)
+-- Forum: CodeIgniter 4 (https://forum.codeigniter.com/forumdisplay.php?fid=28)
+--- Forum: CodeIgniter 4 Support (https://forum.codeigniter.com/forumdisplay.php?fid=30)
+--- Thread: Inadequacy in Documentation (/showthread.php?tid=77347)
Inadequacy in Documentation - bogus - 08-20-2020
Day
as an astute reader of the CI4 documentation I stumbled over a worth mentioning amount of mistakes in the same.
Either logically, but mostly orthographically I wonder if this is intentionally done for whatever reason.
Am I right that it isn't desirable to report these mistakes?
Regards
bogus
RE: Inadequacy in Documentation - jreklund - 08-20-2020
Kinda hard to tell as you didn't list what the problem where.
If the code dosen't work, you should open up an issue at Github; https://github.com/codeigniter4/CodeIgniter4/issues
If you need help interpreting the userguide, you can post here in the forum.
RE: Inadequacy in Documentation - bogus - 08-20-2020
(08-20-2020, 08:49 AM)jreklund Wrote: Kinda hard to tell as you didn't list what the problem where.
If the code dosen't work, you should open up an issue at Github; https://github.com/codeigniter4/CodeIgniter4/issues
If you need help interpreting the userguide, you can post here in the forum.
Na sorry, no need help reading for.
Code is quite okay and didn't dive into it too much yet. TBC
I will send you a PM with hints where there are hooks in the docs, fair enough?
No need for drawing more attention than necessary.
RE: Inadequacy in Documentation - jreklund - 08-20-2020
Our user guide aren't a straight up tutorial so every function or how it's chained aren't described in detail, so that's why I asked if you had trouble with a particular function.
Just write it here as long as it's not a security hole. No one care if we made a mistake in the documentation, we don't try to keep a lid of things.
RE: Inadequacy in Documentation - bogus - 08-21-2020
(08-20-2020, 11:07 PM)jreklund Wrote: Our user guide aren't a straight up tutorial so every function or how it's chained aren't described in detail, so that's why I asked if you had trouble with a particular function.
Just write it here as long as it's not a security hole. No one care if we made a mistake in the documentation, we don't try to keep a lid of things.
But you should, just for the heck ofi it.
CI is really cool, slack free shit... :-)
RE: Inadequacy in Documentation - bogus - 08-24-2020
Quote:Modeling data
|
- Using Codeigniters Model
$updatedField
Specifies which database field should use for keep data record update timestamp. Leave it empty to avoid update it (even useTimestamps is enabled)
Just a minor one.
Reads like an Inuit wrote it.
I'm not 'scanning' the docs now for typos or serious errors.
But I stumbled already about something more serious.
In particular you should point out more the difference between the builder class and the model's member functions.
RE: Inadequacy in Documentation - jreklund - 08-24-2020
You are free to submit any pull request you want regarding the user guide, if you deem it lacking any description.
https://github.com/codeigniter4/CodeIgniter4/tree/develop/contributing
https://github.com/codeigniter4/CodeIgniter4/tree/develop/user_guide_src
https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/documentation.rst