Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve Model and Entity #8587

Merged
merged 7 commits into from
Mar 5, 2024

Conversation

kenjis
Copy link
Member

@kenjis kenjis commented Feb 26, 2024

Description
Closes #8573

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 Feb 26, 2024
qualified name of a class** that can be used with the Result object's ``getCustomResultObject()``
method. Using the special ``::class`` constant of the class will allow most IDEs to
auto-complete the name and allow functions like refactoring to better understand your code.
The Model's **find*()** methods will take a step of work away from you and automatically
Copy link
Contributor

Choose a reason for hiding this comment

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

find()* : Do you mean find(), findColumn(), findAll() ? If yes, I think mentioning these methods makes the explanation clear.is ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes and no. Strictly speaking, all built-in Read (in CRUD) methods in the Model.

@kenjis kenjis merged commit 4c7ca62 into codeigniter4:develop Mar 5, 2024
3 checks passed
@kenjis kenjis deleted the docs-improve-model-entity branch March 5, 2024 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests for documentation only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Entity] Misleading or misunderstood documentation
3 participants