node_load does not document FALSE return value [#1345480]

API page: http://api.drupal.org/api/drupal/modules--node--node.module/function/nod...

Describe the problem you have found:
Return value
Current:
A fully-populated node object.
Expanded:
A fully-populated node object or false if the node is not found.

Comment	File	Size	Author
#9	1345480-d7-node_load_return_documentation.patch	555 bytes	chris.leversuch
#8	1345480-node_load_return_documentation-D7.patch	555 bytes	chris.leversuch
#5	1345480-node_load_return_documentation.patch	588 bytes	chris.leversuch
#3	node_load_return_documentation-1345480.patch	587 bytes	rbayliss
#3	node_load_return_documentation-1345480-D7.patch	554 bytes	rbayliss
#3	node_load_return_documentation-1345480-D6.patch	528 bytes	rbayliss

Comments

Comment #1

jhodgdon

she/her

English

commented 21 November 2011 at 18:48

Version:	7.x-dev	» 8.x-dev
Issue tags:		+Needs backport to D6, +Novice, +Needs backport to D7

That sounds like a good change to make, in D8/7 documentation, and actually D6 too. Looks like a good project for a novice contributor...

Comment #2

jhodgdon

she/her

English

commented 21 November 2011 at 18:48

Title:

Documentation problem with node_load

» node_load does not document FALSE return value

Status	File	Size
new	node_load_return_documentation-1345480-D6.patch	528 bytes
new	node_load_return_documentation-1345480-D7.patch	554 bytes
new	node_load_return_documentation-1345480.patch	587 bytes

Comment #4

jhodgdon

she/her

English

commented 6 December 2011 at 16:27

Status:

Needs review

» Needs work

Thanks! Can you add a comma before the "or"?

Also, I recommend just making the patch for D8 on the first go-around, and then after that patch has been accepted and committed, only then making a d7 or d6 version. This saves time and effort, since there are often changes reviewers point out that are needed in the d8 version -- might as well get that right before taking the time to port it to other versions of Drupal.