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

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

Merged
merged 2 commits into from
Apr 8, 2024

Conversation

ictbeheer
Copy link
Contributor

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:

  • 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 felipeelia added this to the 5.1.0 milestone Apr 4, 2024
@felipeelia
Copy link
Member

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

@ictbeheer
Copy link
Contributor Author

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

@felipeelia felipeelia merged commit 18e3c7f into 10up:develop Apr 8, 2024
@ictbeheer ictbeheer deleted the fix/return-type branch April 9, 2024 07:00
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

Successfully merging this pull request may close these issues.

BUG: Return type of ElasticPress\Elasticsearch::index_document incorrectly documented
2 participants