cakephp-api-docs icon indicating copy to clipboard operation
cakephp-api-docs copied to clipboard

`updateAll()` return value - ?

Open mehov opened this issue 1 year ago • 1 comments

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?

mehov avatar Apr 16 '24 16:04 mehov

Other return types are also missing their description text.

markstory avatar Apr 18 '24 14:04 markstory