file_cron() has incorrect hook documentation

/**
 * Implements file_cron()
 */
function file_cron() {

Should be replaced with:

/**
 * Implements hook_cron()
 */
function file_cron() {

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue category Bug because doc is wrong for file_cron().
Issue priority Normal because its self-contained.
Unfrozen changes Unfrozen because documentation is unfrozen.
CommentFileSizeAuthor
#5 2523048-file_cron-phpdoc-5.patch399 bytesdpi
#1 2523048-file_cron-phpdoc.patch398 bytesdpi

Comments

dpi’s picture

dpi
Location Perth, Australia
commented
Status: Active » Needs review
StatusFileSize
new 2523048-file_cron-phpdoc.patch398 bytes

Status: Needs review » Needs work

The last submitted patch, 1: 2523048-file_cron-phpdoc.patch, failed testing.

Status: Needs work » Needs review

dpi queued 1: 2523048-file_cron-phpdoc.patch for re-testing.

cilefen’s picture

cilefen commented
Status: Needs review » Needs work 
+++ b/core/modules/file/file.module
@@ -627,7 +627,7 @@ function file_file_download($uri) {
+ * Implements hook_cron()

You need a period at the end of this comment.

dpi’s picture

dpi
Location Perth, Australia
commented
Status: Needs work » Needs review
StatusFileSize
new 2523048-file_cron-phpdoc-5.patch399 bytes

Done.

Anonymous’s picture

Anonymous (not verified) commented
Issue summary: View changes
Status: Needs review » Reviewed & tested by the community
Issue tags: +Quickfix

Good find! Added beta eval.

cilefen’s picture

cilefen commented
Issue summary: View changes
webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Component: file system » documentation
Status: Reviewed & tested by the community » Fixed

Nice catch.

Committed and pushed to 8.0.x. Thanks!

  • webchick committed e5018e6 on 8.0.x 
    Issue #2523048 by dpi: file.modules hook_cron implementation has...

Status: Fixed » Closed (fixed)

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

dpi’s picture

dpi
Location Perth, Australia
commented
Assigned: dpi » Unassigned