Documentation: Incorrect key in drupal_mail function

meba - June 23, 2008 - 09:15
Project:Drupal
Version:7.x-dev
Component:documentation
Category:bug report
Priority:critical
Assigned:Unassigned
Status:closed
Description

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.

AttachmentSize
drupal6_mail.patch697 bytes

#1

jsaints - October 5, 2008 - 18:01
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.

AttachmentSize
drupal_mail_documentation_correction.patch 714 bytes

#2

earnie - October 5, 2008 - 19:25
Priority:normal» critical
Status:needs review» reviewed & tested by the community

Critical documentation bug. Simple change.

#3

Dries - October 6, 2008 - 11:04
Status:reviewed & tested by the community» fixed

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

--project followup subject--

Anonymous (not verified) - October 20, 2008 - 11:15

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

#4

Anonymous (not verified) - October 20, 2008 - 11:21
Status:fixed» closed

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

 
 

Drupal is a registered trademark of Dries Buytaert.