-
Notifications
You must be signed in to change notification settings - Fork 98
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 phpdoc block of IndexesResults constructor #398
Fix phpdoc block of IndexesResults constructor #398
Conversation
Hello @jonatanrdsantos, PS: This message was sent automatically! |
34c8da6
to
c9a74e0
Compare
c9a74e0
to
7d8e091
Compare
Yes indeed, can you create a descriptive issue explaining how the correct behavior should be implemented? We can work on that in the future then... Thanks a lot for your time :) |
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.
bors merge
Build succeeded:
|
This message is sent automatically Thanks again for contributing to Meilisearch ❤️ |
This is not a fix. It just removes a proper typehint that |
Hi @norkunas yes, I was not able to fix it, so I removed it as it was causing errors. Meilisearch probably will work on a backlog of issues for documenting the code as the docs get introduced recently. If you or someone can fix it, I will be glad to learn from it. I'm quite new to docs tools so will be very teachable. |
This class has a bad constructor. It's receiving an array instead of an object as a parameter, which is not a good practice, and PHPdoc does not have a good implementation for documenting nested arrays, so for now what we can do is remove the doc-block, and when a better implementation comes in, we updated doc-block as well.
Related issue
Fixes #397
What does this PR do?
IndexesResults
constructor fixing Fix invalid Fqsen in docs generation #397PR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!