-
Notifications
You must be signed in to change notification settings - Fork 117
PR for Add clear docblock to all classes and interfaces #298
base: master
Are you sure you want to change the base?
Conversation
…ctTableGateway and TableGatewayInterface
src/ResultSet/AbstractResultSet.php
Outdated
|
|
||
| /** | ||
| * @var Iterator|IteratorAggregate|ResultInterface | ||
| * @var Iterator|IteratorAggregate|ResultInterface|ArrayIterator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ArrayIterator is not really needed - the interfaces cover that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are right, but it is not in my file at https://github.com/fadoe/zend-db/blob/feature/docblock/src/ResultSet/AbstractResultSet.php#L36
Do you know why it is here?
| /** | ||
| * Select | ||
| * | ||
| * @param Where|\Closure|string|array $where |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can it still be null?
| /** | ||
| * Insert | ||
| * | ||
| * @param array $set |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a description here
| * Insert | ||
| * | ||
| * @param array $set | ||
| * @return int |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a description here (number of affected rows)
| /** | ||
| * Update | ||
| * | ||
| * @param array $set |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a description here
| * Update | ||
| * | ||
| * @param array $set | ||
| * @param string|array|\Closure $where |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can it still be null?
| * @param array $set | ||
| * @param string|array|\Closure $where | ||
| * | ||
| * @return int |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description
| public function update($set, $where = null); | ||
|
|
||
| /** | ||
| * Delete |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, these one-word descriptions are not useful. Drop them overall unless there is something to clarify further
|
This repository has been moved to laminas/laminas-db. If you feel that this patch is still relevant, please re-open against that repository, and reference this issue. To re-open, we suggest the following workflow:
|
|
This repository has been closed and moved to laminas/laminas-db; a new issue has been opened at laminas/laminas-db#57. |
This PR is for #297 and adds some docblocks for classes and interfaces.