Seen on #drupal-contribute:

[21:01] <Druplicon> file_scan_directory: [Documented summary is not one line. This is a bug. File a patch!] => file_scan_directory($dir, $mask, $nomask = array('.', '..', 'CVS'), $callback = 0, $recurse = TRUE, $key = 'filename', $min_depth = 0, $depth = 0) => http://api.drupal.org/api/function/file_scan_directory/6

If you follow the link given, you will see that the documented summary is one line, to wit:

Finds all files that match a given mask in a given directory.

Since Druplicon is obviously incorrect according to the API, how can this be fixed?

Comments

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Status: Active » Closed (works as designed)

Look at the code in D6:

/**
 * Finds all files that match a given mask in a given directory.
 * Directories and files beginning with a period are excluded; this
 * prevents hidden files and directories (such as SVN working directories)
 * from being scanned.

D6 needs to be patched to have a new line between the first and second lines. Bot module is reporting this correctly.

pillarsdotnet’s picture

pillarsdotnet commented

Ah. Thanks. I guess api.drupal.org is inserting the blank line, then.

pillarsdotnet’s picture

pillarsdotnet commented
Status: Closed (works as designed) » Active

No, I just checked 6.x. There is a blank line.

See http://drupalcode.org/project/drupal.git/blob/refs/heads/6.x:/includes/file.inc#l924.

pillarsdotnet’s picture

pillarsdotnet commented

The blank line was inserted by this patch and committed here.

Here's the commit diff.

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented

Hrm, interesting.

pillarsdotnet’s picture

pillarsdotnet commented

Perhaps Druplicon is inspecting the 6.x code on the Drupal installation where it is running?

morbus iff’s picture

morbus iff
they/them
commented
Status: Active » Closed (works as designed)

Druplicon's API lookups are stalled in time from circa late D6, early D7, solely because api.module hasn't been ported to D7 yet. This has been a continual problem with providing said lookups, and there are plans to eventually move to an api.module-less approach, per #1061292.