As a natural companion to #1697750: Improve documentation of drupal_set_message(), the docblock for drupal_get_messages() needs improvement. It has at least the following issues:

  • It doesn't specify the parameter or return types.
  • It doesn't specify all of the parameter defaults or acceptable values.
  • It doesn't make it clear whether $clear_queue will clear all messages or just those of the type specified in the $type parameter.
  • It doesn't @see closely-related functions.
  • The grammar and English style can be improved a little.

Patch to follow.

#1 drupal-drupal_get_messages-docblock-1765918-1.patch1.81 KBTravisCarden
PASSED: [[SimpleTest]]: [MySQL] 40,389 pass(es).
[ View ]


TravisCarden’s picture

Status:Active» Needs review
new1.81 KB
PASSED: [[SimpleTest]]: [MySQL] 40,389 pass(es).
[ View ]
amitgoyal’s picture

Status:Needs review» Reviewed & tested by the community

TravisCarden - Looks good to me!

jhodgdon’s picture

Status:Reviewed & tested by the community» Fixed
Issue tags:-documentation+needs backport to D7

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

By the way, please do not add tag "documentation" to issues in component "documentation". Read the tag guidelines (links below the Tags field). :)

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

TravisCarden’s picture

Assigned:TravisCarden» Unassigned
Issue summary:View changes