Opened 8 years ago

Closed 8 years ago

#4290 closed (fixed)

misleading comment about trailing slash on MEDIA_URL in settings.py

Reported by: mw@… Owned by: adrian
Component: Core (Management commands) Version: master
Severity: Keywords: MEDIA_URL django-admin
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Currently it says:

# URL that handles the media served from MEDIA_ROOT.
# Example: "http://media.lawrence.com"

Which is an error, since the MEDIA_URL has to end with a "/" as far as I know.
So I add this little patch that corrects this comment.

It's no code change, but a real pitfall for new users coming to django.

Attachments (1)

conf_project_template_settings.py.diff (518 bytes) - added by mw@… 8 years ago.
patch for the documentation-comment

Download all attachments as: .zip

Change History (3)

Changed 8 years ago by mw@…

patch for the documentation-comment

comment:1 Changed 8 years ago by Simon G. <dev@…>

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Summary changed from misleading comment in conf/project_template/settings.py to misleading comment about trailing slash on MEDIA_URL in settings.py
  • Triage Stage changed from Unreviewed to Ready for checkin

This is only true if the url has a path component, but this is the type of thing that can confuse people. It may be worth removing the / for http://media.lawrence.com but keeping the other example, but I'll leave that up to the checker-in.

comment:2 Changed 8 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from new to closed

(In [5404]) Fixed #4290 -- Added a warning about trailing slashes to the project settings
file. Thanks, mw@….

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