Improving phpDoc #3635
Merged
Improving phpDoc #3635
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
renatonascalves
commented
Sep 6, 2023
| @@ -49,7 +48,7 @@ abstract class Indexable { | |||
| * Instance of QueryIntegration. This should handle integrating with a default | |||
| * WP query. | |||
| * | |||
| * @var QueryIntegration | |||
| * @var object | |||
There was a problem hiding this comment.
None of the core features extends this class. So this object here is incorrect.
One gets this error while extending the class.
Property ElasticPress\Indexable::$query_integration (ElasticPress\QueryIntegration) does not accept Project\QueryIntegration.
```
renatonascalves
commented
Sep 6, 2023
| @@ -152,7 +152,7 @@ public function get_all( $global = null, $slug_only = false, $status = 'active' | |||
| /** | |||
| * Return singleton instance of class | |||
| * | |||
| * @return object | |||
| * @return self | |||
There was a problem hiding this comment.
Intellisense tools will make better use of this with self. Currently, one gets this:
Call to an undefined method object::get().
renatonascalves
commented
Sep 6, 2023
| * @since 3.1.2 | ||
| * @since 3.1.2 | ||
| * | ||
| * @param int $object_id Object ID to sync. |
There was a problem hiding this comment.
Fixes this error:
Parameter #1 $object_id of method ElasticPress\SyncManager::add_to_queue() expects ElasticPress\id, int given.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change
phpDoc improvements.
How to test the Change
You can run phpstan in the project and confirm the errors.
Changelog Entry
Credits
@renatonascalves
Checklist: