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

updateAll() return value - ? #320

Open
mehov opened this issue Apr 16, 2024 · 1 comment
Open

updateAll() return value - ? #320

mehov opened this issue Apr 16, 2024 · 1 comment

Comments

@mehov
Copy link

mehov commented Apr 16, 2024

Hey everyone

https://api.cakephp.org/5.0/class-Cake.ORM.Table.html#updateAll()
https://api.cakephp.org/4.0/class-Cake.ORM.Table.html#updateAll()
https://api.cakephp.org/3.0/class-Cake.ORM.Table.html#updateAll()

Returns
int

What int?

I like looking things up on api.cakephp.org specifically because I can click directly into the source code and get my answers there:

https://github.com/cakephp/cakephp/blob/8f56e5295ba2bda1239b3c296d758599f8d02020/src/ORM/Table.php#L1820

But I can see how someone new may not think of that or may not know it's possible even.

In my understanding, unlike book.cakephp.org, the api.cakephp.org documents are being generated directly from the source code comments. And updateAll()'s phpDoc does indeed have description of the return value:

  • @return int Count Returns the affected rows.

So why is it not being picked up?

@ADmad ADmad transferred this issue from cakephp/docs Apr 16, 2024
@markstory
Copy link
Member

Other return types are also missing their description text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants