Opened 18 years ago
Closed 18 years ago
#4163 closed (fixed)
EMAIL_HOST_PASSWORD doc says it's a Username
Reported by: | Owned by: | Jacob | |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Keywords: | ||
Cc: | Triage Stage: | Ready for checkin | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
The documentation for EMAIL_HOST_PASSWORD states that it is the: "Username to use for the SMTP server defined in EMAIL_HOST. If empty, Django won’t attempt authentication." Shouldn't that be Password? Maybe something like:
Password to use for the SMTP server defined in EMAIL_HOST. This setting is used in conjunction with EMAIL_HOST_USER when authenticating to the SMTP server. If either of these settings is empty, Django won't attempt authenticaion.
(I actually didn't check the code to see if that last sentence is true; I'm not sure what the code does if one of these is empty but the other is not.)
I'd also suggest that it would be helpful if the send_mail documentation (http://www.djangoproject.com/documentation/email/) pointed to these settings. Not sure if that should be a different ticket?
Attachments (1)
Change History (7)
comment:1 by , 18 years ago
Needs documentation: | set |
---|---|
Triage Stage: | Unreviewed → Accepted |
by , 18 years ago
comment:2 by , 18 years ago
Has patch: | set |
---|---|
Needs documentation: | unset |
Well I took a shot at it, though I'll admit I'm unfamiliar with the format of the documentation files (is it described somewhere? I couldn't find it.) So I just tried to match what I already saw being done there. Hopefully it's at least useful as a starting idea for what to change.
comment:3 by , 18 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
Thanks Karen, great job! Better than a starting idea, I reckon that's about ready for checkin.
comment:5 by , 18 years ago
Thanks for the pointer, that'll come in handy for any future doc changes I might suggest. I also forgot to mention that I did verify that the one sentence I wasn't sure about above is a correct description of how the code works.
comment:6 by , 18 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
Thanks for the report, Karen.
I say this ticket can probably cover both issues. If you have the competence, a patch would be helpful!