#37172 closed Cleanup/optimization (fixed)
FILE_UPLOAD_HANDLERS settings reference should link to "File Uploads" topic page
| Reported by: | Lincoln | Owned by: | Lincoln |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Lincoln | 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 FILE_UPLOAD_HANDLERS settings reference:
https://docs.djangoproject.com/en/dev/ref/settings/#file-upload-handlers
Currently links to the "Managing files" topic page (https://docs.djangoproject.com/en/dev/topics/files/) - "See Managing files for details."
Nothing on this topic page actually talks about file uploads, it is mostly about files in models and file storage.
I think the settings reference should instead link to the "File uploads" topic page (https://docs.djangoproject.com/en/dev/topics/http/file-uploads/),
because that page has the "Upload Handlers" section that actually talks about that setting and how it is used.
Probably could make the same change to settings reference for FILE_UPLOAD_MAX_MEMORY_SIZE and FILE_UPLOAD_TEMP_DIR
I am happy to provide a PR if this ticket is accepted.
Thanks!
Change History (10)
comment:1 by , 3 weeks ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:2 by , 3 weeks ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:3 by , 3 weeks ago
| Has patch: | set |
|---|
comment:4 by , 3 weeks ago
Thanks! PR is open. I made all the links go to the Upload handlers section since a) I didn't want to link too deep into the document tree and b) The "Where uploaded data is stored" section is still visible on screen when opening to its parent header.
comment:5 by , 2 weeks ago
| Patch needs improvement: | set |
|---|
comment:6 by , 13 days ago
| Patch needs improvement: | unset |
|---|
comment:7 by , 11 days ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
Thanks for the report. That does seem like a much better link.
Specifically, the
FILE_UPLOAD_HANDLERSsetting should reference Upload handlers in the File uploads topic.I agree the links in
FILE_UPLOAD_MAX_MEMORY_SIZEandFILE_UPLOAD_TEMP_DIRshould also be changed. Those could either go to the the same Upload handlers section or its Where uploaded data is stored subsection.