Opened 16 years ago
Closed 16 years ago
#5870 closed (fixed)
send-mail docs out of date
Reported by: | 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 |
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
Change History (3)
comment:1 Changed 16 years ago by
comment:2 Changed 16 years ago by
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 Changed 16 years ago by
Resolution: | → fixed |
---|---|
Status: | new → closed |
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.