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.

CommentFileSizeAuthor
#7 3066539-7.patch1.01 KBshubham.prakash
#4 core-doc-search-change-3066539-4-08.patch881 bytesujin

Comments

jhodgdon created an issue. See original summary.

aiglesiasn’s picture

aiglesiasn commented

Hi jhodgdon, I want to start helping in the community. How can I update the info in the API. Thanks!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

See
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!

ujin’s picture

ujin commented
StatusFileSize
new core-doc-search-change-3066539-4-08.patch881 bytes

Please inspect.

init90’s picture

init90
Location Ukraine
commented
Status: Active » Reviewed & tested by the community

Looks good:)

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Needs work

Not 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!

shubham.prakash’s picture

shubham.prakash commented
Status: Needs work » Needs review
StatusFileSize
new 3066539-7.patch1.01 KB

This patch will fix the mentioned issue.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Looks good now, thanks!

anavarre’s picture

anavarre
Primary language French
Location 🇪🇺
commented
Version: 8.7.x-dev » 8.8.x-dev
shubham.prakash’s picture

shubham.prakash commented

The patch in #7 applies both in 8.8.x-dev as well as 8.7.x-dev.

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Committed 01e11fa and pushed to 8.8.x. Thanks!

  • catch committed 01e11fa on 8.8.x 
    Issue #3066539 by shubham.prakash, Ujin, jhodgdon: Docs for...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.