Django

Code

Ticket #5870 (closed: fixed)

Opened 10 months ago

Last modified 9 months ago

send-mail docs out of date

Reported by: Carl Karsten <carl@personnelware.com> Assigned to: nobody
Milestone: Component: Documentation
Version: SVN Keywords: deprecated email
Cc: Triage Stage: Unreviewed
Has patch: 0 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

help( send_mail ) 

Help on function send_mail in module django.core.mail:
    NOTE: This method is deprecated. It exists for backwards compatibility.
    New code should use the EmailMessage class directly.

This should be stated in http://www.djangoproject.com/documentation/email/#send-mail

Attachments

Change History

11/03/07 18:44:50 changed by Carl Karsten <carl@personnelware.com>

  • needs_better_patch changed.
  • needs_tests changed.
  • needs_docs changed.

same page:

http://www.djangoproject.com/documentation/email/#the-emailmessage-and-smtpconnection-classes

.send() doesn't have it's interface documented.

def send(self, fail_silently=False):

from IRC jodal: CarlFK: yes, looks like the docs are lacking compared to the source.

Guessing the whole thing should be reviewed.

11/03/07 19:15:16 changed by mtredinnick

The first one is borderline. There's a difference between deprecated for internal Django use and deprecated as part of the external API (which is what is documented in the text). Anybody reading the docstring is quite free not to use send_mail(), but I'm not sure it's worth asking everybody to port away from it in public code yet.

For the second one, we take patches.

12/01/07 11:20:19 changed by ubernostrum

  • status changed from new to closed.
  • resolution set to fixed.

(In [6790]) Fixed #5870: documented the "fail_silently" argument to EmailMessage?.send().

Add/Change #5870 (send-mail docs out of date)




Change Properties
Action