API page: https://api.drupal.org/api/drupal/core%21modules%21system%21system.api.p...

The documentation for hook_schema() needs improvement. It has at least the following issues:

  • It doesn't specify its @return types.
  • It doesn't @see closely-related functions.
  • It has minor comment formatting issues.

Patch to follow.

CommentFileSizeAuthor
#3 drupal8.documentation.2061843-2.patch2.64 KBtraviscarden
#3 word-diff-do-not-test.diff1.9 KBtraviscarden
#1 drupal8.documentation.2061843-1.patch2.64 KBtraviscarden
#1 word-diff.diff1.9 KBtraviscarden

Comments

traviscarden’s picture

traviscarden commented
Status: Active » Needs review
Issue tags: +Novice
StatusFileSize
new word-diff.diff1.9 KB
new drupal8.documentation.2061843-1.patch2.64 KB

Most of the changes in the attached patch are merely justifying text to fill the available line length. A word-diff makes it easier to see at a glance that the text itself is not being changed, so I'm attaching one. Other than that, I think this is pretty self-explanatory.

Status: Needs review » Needs work

The last submitted patch, word-diff.diff, failed testing.

traviscarden’s picture

traviscarden commented
Status: Needs work » Needs review
StatusFileSize
new word-diff-do-not-test.diff1.9 KB
new drupal8.documentation.2061843-2.patch2.64 KB

Mmm. I was afraid the testbot might want to test the word-diff. Let's try again.

traviscarden’s picture

traviscarden commented
Assigned: traviscarden » Unassigned
jhodgdon’s picture

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

Thanks! good to go.

jhodgdon’s picture

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

Thanks again! Committed to 8.x.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Committed it to 7.x too.

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