Long function summary line is misleading [#516152]

[7:51pm] tha_sun:
cache_get:7?
[7:51pm] Druplicon:
cache_get: [Documented summary is not one line. This is a bug. File a patch!] => cache_get($cid, $bin = 'cache') => http://api.drupal.org/api/function/cache_get/7

The summary is currently:

Return data from the persistent cache. Data may be stored as either plain text or as serialized data. cache_get will automatically return unserialized objects and arrays.

The real problem is not that the summary is more than one line, it's that it's more than one sentence. I think the message should be changed to reflect this.

Comment	File	Size	Author
#2	bot_516152.patch	1.63 KB	drewish

Comments

Comment #1

sun

German

Karlsruhe

commented 11 July 2009 at 00:07

The summary is:

/**
 * Return data from the persistent cache. Data may be stored as either plain
 * text or as serialized data. cache_get will automatically return
 * unserialized objects and arrays.
 *

Not sure whether this issue shouldn't be moved to Coder or even Drupal core.