field_info_field() does not document return value on failure [#1689394]

API page: http://api.drupal.org/api/drupal/core%21modules%21field%21field.info.inc...

Enter a descriptive title (above) relating to field_info_field, then describe the problem you have found:

I can *see* that on failure I will get a NULL, but the PHPDoc is missing it.

Comment	File	Size	Author
#3	field_info_field-does-not-1689394-3.patch	584 bytes	mjonesdinero
#3
#1	added_Return_message.patch	683 bytes	ro-no-lo
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

ro-no-lo CreditAttribution: ro-no-lo commented 17 July 2012 at 12:17

File	Size
added_Return_message.patch	683 bytes

Not sure if the *.patch files have a standard format. I created this one with hg and phpstorm.

Comment #2

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 17 July 2012 at 17:52

Title:	Return on failure missing	» field_info_field() does not document return value on failure
Status:	Active	» Needs work
Issue tags:		+Novice, +Needs backport to D7

Thanks for the patch! It isn't quite the right format -- you need to use Git to make a patch, and when uploading, set the issue status to "needs review" to trigger both human and test-bot reviewers that you have made a patch.

See http://drupal.org/node/707484 , or http://drupal.org/novice if you need more extensive help in getting started as a Drupal Core contributor.

Meanwhile, perhaps someone can re-roll this patch? Please also put "the" in "NULL if *the* field was not found." :)