Download & Extend

Documentation: Incorrect key in drupal_mail function

Project:Drupal core
Version:7.x-dev
Component:documentation
Category:bug report
Priority:critical
Assigned:Unassigned
Status:closed (fixed)

Issue Summary

http://api.drupal.org/?q=api/function/drupal_mail/6

function example_notify is sending a key to example_mail here, where key = 'notify'

But example_mail sends mail after receiving a key = 'notice'

In this example, mail will never be sent.

AttachmentSizeStatusTest resultOperations
drupal6_mail.patch697 bytesIgnored: Check issue status.NoneNone

Comments

#1

Version:6.2» 7.x-dev

Just doing some "farming" here. I can confirm this documentation bug.

I rerolled the patch for HEAD (D7). Seems like a simple fix that will help others avoid confusion when they follow the example in the documentation.

AttachmentSizeStatusTest resultOperations
drupal_mail_documentation_correction.patch714 bytesIgnored: Check issue status.NoneNone

#2

Priority:normal» critical
Status:needs review» reviewed & tested by the community

Critical documentation bug. Simple change.

#3

Status:reviewed & tested by the community» fixed

I've committed this patch to CVS HEAD and DRUPAL-6. Thanks!

--project followup subject--

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

#4

Status:fixed» closed (fixed)

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

nobody click here