Opened 17 years ago

Closed 17 years ago

#5870 closed (fixed)

send-mail docs out of date

Reported by: Carl Karsten <carl@…> Owned by: nobody
Component: Documentation Version: dev
Severity: Keywords: deprecated email
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


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

Change History (3)

comment:1 by Carl Karsten <carl@…>, 17 years ago

same page:

.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.

comment:2 by Malcolm Tredinnick, 17 years ago

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.

comment:3 by James Bennett, 17 years ago

Resolution: fixed
Status: newclosed

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

Note: See TracTickets for help on using tickets.
Back to Top