(fix) correct return type for Elasticsearch::index_document in phpdoc - Githubissues

10up / ElasticPress

A fast and flexible search and query engine for WordPress.

https://elasticpress.io

GNU General Public License v2.0

1.24k stars 312 forks source link

(fix) correct return type for Elasticsearch::index_document in phpdoc #3881

Closed ictbeheer closed 5 months ago

ictbeheer commented 5 months ago

Description of the Change

This PR corrects the phpdoc return type for Elasticsearch::index_document to prevent false IDE and static analyser warnings. Closes #3880

How to test the Change

N/A

Changelog Entry

Fixed: Correct PHPdoc return type for correct Elasticsearch::index_document

Credits

@ictbeheer

Checklist:

[x] I agree to follow this project's Code of Conduct.
[ ] I have updated the documentation accordingly.
[ ] I have added tests to cover my change.
[ ] All new and existing tests pass.

felipeelia commented 5 months ago

Hi @ictbeheer, thanks for opening the Pull Request! Can you please adjust the docs for the Indexable::index method and for the 'ep_afterindex$slug' action as well? Thanks!

ictbeheer commented 5 months ago

Hello @felipeelia I've changed those docs as well now.