API page: https://api.drupal.org/api/drupal/core%21modules%21search%21search.modul...
The search_index_clear() function's second argument can be of type int or array of int or null. It is documented to be a string or null, which is incorrect.
In addition, the text description of this parameter should be updated to say that it can be an ID or an array of IDs.
| Comment | File | Size | Author |
|---|---|---|---|
| #7 | 3066539-7.patch | 1.01 KB | shubham.prakash |
| #4 | core-doc-search-change-3066539-4-08.patch | 881 bytes | ujin |
Comments
Comment #2
aiglesiasn commentedHi jhodgdon, I want to start helping in the community. How can I update the info in the API. Thanks!
Comment #3
jhodgdonSee
a) https://www.drupal.org/node/144223
for an overview of how the docs on api.drupal.org are generated
b) https://www.drupal.org/docs/develop/standards/api-documentation-and-comm...
for standards of how to write docs
c) https://www.drupal.org/contributor-tasks/create-patch
for how to make a Drupal Core patch
There are also mentors available. See
https://www.drupal.org/core-office-hours
I do not have time to provide mentoring beyond the links above. Thanks for your interest!
Comment #4
ujin commentedPlease inspect.
Comment #5
init90Looks good:)
Comment #6
jhodgdonNot quite! The edited line goes over 80 characters. We don't want docs lines to go over 80 characters. Please rewrap it with the next line so that it fits into 80-character lines.
The changes look good other than that. Thanks!
Comment #7
shubham.prakash commentedThis patch will fix the mentioned issue.
Comment #8
jhodgdonLooks good now, thanks!
Comment #9
anavarreComment #10
shubham.prakash commentedThe patch in #7 applies both in 8.8.x-dev as well as 8.7.x-dev.
Comment #11
catchCommitted 01e11fa and pushed to 8.8.x. Thanks!