Skip to content

docs: improve Factories#5857

Merged
kenjis merged 13 commits intocodeigniter4:developfrom
kenjis:fix-docs-factories
Apr 6, 2022
Merged

docs: improve Factories#5857
kenjis merged 13 commits intocodeigniter4:developfrom
kenjis:fix-docs-factories

Conversation

@kenjis
Copy link
Copy Markdown
Member

@kenjis kenjis commented Apr 4, 2022

Description

  • add Differences from Services
  • add Convenience Functions
  • add preferApp behavior in Example

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

@kenjis kenjis added the documentation Pull requests for documentation only label Apr 4, 2022
@kenjis kenjis force-pushed the fix-docs-factories branch from 5dc53ff to c0884be Compare April 4, 2022 04:54
@kenjis kenjis requested a review from MGatner April 4, 2022 23:27
MGatner
MGatner requested changes Apr 5, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@MGatner MGatner left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great changes, much easier to understand! A few small syntax suggestions.

Comment thread user_guide_src/source/concepts/factories.rst Outdated
Comment thread user_guide_src/source/concepts/factories.rst Outdated
Comment thread user_guide_src/source/concepts/factories.rst Outdated
Comment thread user_guide_src/source/concepts/factories.rst Outdated

.. literalinclude:: factories/005.php

This would prevent conflict of an unrelated third-party module which happened to have an
Copy link
Copy Markdown
Member

@MGatner MGatner Apr 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drop this "unrelated" in favor of the one in the next line.

Copy link
Copy Markdown
Member Author

@kenjis kenjis Apr 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

kenjis and others added 6 commits April 6, 2022 08:50
@kenjis @MGatner
docs: fix by proofreading
b71ed71 
Co-authored-by: MGatner <mgatner@icloud.com>
@kenjis @MGatner
docs: fix by proofreading
b1a77e7 
Co-authored-by: MGatner <mgatner@icloud.com>
@kenjis @MGatner
docs: fix by proofreading
12aa1aa 
Co-authored-by: MGatner <mgatner@icloud.com>
@kenjis
docs: remove duplicated "unrelated"
d41fbe2
@kenjis
docs: add more explanation for filters component
ac6a97d
@kenjis
docs: revise the description to be more accurate
6214ece 
The property $component does not exist.
@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Apr 6, 2022

@MGatner Thank you for proofreading!
To make it more understandable, I have added the last two commits.

@kenjis kenjis requested a review from MGatner April 6, 2022 00:51
paulbalandan
paulbalandan reviewed Apr 6, 2022
View reviewed changes
Comment thread user_guide_src/source/concepts/factories.rst Outdated
Comment thread user_guide_src/source/concepts/factories.rst Outdated
Comment thread user_guide_src/source/concepts/factories.rst Outdated
kenjis and others added 3 commits April 6, 2022 17:28
@kenjis @paulbalandan
docs: fix by proofreading
c01667d 
Co-authored-by: John Paul E. Balandan, CPA <51850998+paulbalandan@users.noreply.github.com>
@kenjis @paulbalandan
docs: fix by proofreading
cd2abe8 
Co-authored-by: John Paul E. Balandan, CPA <51850998+paulbalandan@users.noreply.github.com>
@kenjis @paulbalandan
docs: fix by proofreading
9dd0e02 
Co-authored-by: John Paul E. Balandan, CPA <51850998+paulbalandan@users.noreply.github.com>
@kenjis
docs: fix title underline
9f2d3ce 
factories.rst:13: WARNING: Title underline too short.
@kenjis kenjis merged commit 64308d4 into codeigniter4:develop Apr 6, 2022
@kenjis kenjis deleted the fix-docs-factories branch April 6, 2022 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lonnieezell lonnieezell lonnieezell approved these changes

@MGatner MGatner MGatner approved these changes

@paulbalandan paulbalandan paulbalandan approved these changes

Assignees

No one assigned

Labels

documentation Pull requests for documentation only

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kenjis @lonnieezell @MGatner @paulbalandan