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

Describe the problem you have found:

No PhpDoc at all even though this function has a param and a return value.

Please add these so that smart IDEs can use it for IntelliSense support.

CommentFileSizeAuthor
#7 node_last_changed_patch3-1196318-4827762.patch574 bytesJames_Stallings
#5 node_last_changed_patch2-1196318-4817982.patch572 bytesJames_Stallings
#3 node_last_changed_patch1-1196318-4805274.patch528 bytesJames_Stallings

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Title: Documentation problem with node_last_changed » node_last_changed is lacking doc
Version: 7.2 » 8.x-dev
Issue tags: +Needs backport to D7

Thanks for reporting! We fix in 8.x then port back to 7.x

James_Stallings’s picture

James_Stallings commented
Assigned: Unassigned » James_Stallings
James_Stallings’s picture

James_Stallings commented
Assigned: James_Stallings » Unassigned
Status: Active » Needs review
StatusFileSize
new node_last_changed_patch1-1196318-4805274.patch528 bytes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

"id" is a psychological term -- please use ID to refer to an identifying number (yes, I know -- not done consistently in the current doc, but we're trying!). :)

You might also consider in the @return adding "giving the time the node was last updated" or something like that?

James_Stallings’s picture

James_Stallings commented
Status: Needs work » Needs review
StatusFileSize
new node_last_changed_patch2-1196318-4817982.patch572 bytes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Almost there! The only thing I would change is a -> the in the @return, because by the time the function is returning, we are talking about a specific node:

+ * @return
+ *   A unix timestamp indicating the last time a node was changed.

should be "last time the node was changed"

James_Stallings’s picture

James_Stallings commented
Status: Needs work » Needs review
StatusFileSize
new node_last_changed_patch3-1196318-4827762.patch574 bytes

All set!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Looks good! 8.x/7.x material.

dries’s picture

dries commented
Status: Reviewed & tested by the community » Fixed

Committed to 7.x and 8.x. Thanks.

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