Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#22347 closed Cleanup/optimization (fixed)

FileSystemStorage documentation spread out in different places

Reported by: nliberg Owned by: Vishal Lal
Component: Documentation Version: dev
Severity: Normal Keywords: FileSystemStorage
Cc: Vishal Lal Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The FileSystemStorage constructor parameters are not described in one place. Two of the parameters are described on an overview page:
https://docs.djangoproject.com/en/dev/topics/files/#the-built-in-filesystem-storage-class
and the two other are described on the File storage API page:
https://docs.djangoproject.com/en/dev/ref/files/storage/#the-filesystemstorage-class

It would probably be good if the API page described all four parameters.

Change History (4)

comment:1 by Tim Graham, 10 years ago

Triage Stage: UnreviewedAccepted

Would be best to put them on the reference doc only, I think. We should add a proper link to FileSystemStorage in the topic guide.

comment:2 by Vishal Lal, 10 years ago

Cc: Vishal Lal added
Has patch: set
Owner: changed from nobody to Vishal Lal
Status: newassigned

Issued Pull Request #2506. Verified documentation builds properly.

comment:3 by Tim Graham <timograham@…>, 10 years ago

Resolution: fixed
Status: assignedclosed

In ca93f02c621ea0f686e0bde3e4130e99116fd9d5:

Fixed #22347 -- Unified FileSystemStorage documentation.

Thanks nliberg for the report.

comment:4 by Tim Graham <timograham@…>, 10 years ago

In 36d1e3725fd0b6a196ddb662fd1eb8bca638d38c:

[1.7.x] Fixed #22347 -- Unified FileSystemStorage documentation.

Thanks nliberg for the report.

Backport of ca93f02c62 from master

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