Opened 16 months ago

Closed 16 months ago

Last modified 16 months ago

#22347 closed Cleanup/optimization (fixed)

FileSystemStorage documentation spread out in different places

Reported by: nliberg Owned by: vlal
Component: Documentation Version: master
Severity: Normal Keywords: FileSystemStorage
Cc: vlal 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 Changed 16 months ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

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 Changed 16 months ago by vlal

  • Cc vlal added
  • Has patch set
  • Owner changed from nobody to vlal
  • Status changed from new to assigned

Issued Pull Request #2506. Verified documentation builds properly.

comment:3 Changed 16 months ago by Tim Graham <timograham@…>

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

In ca93f02c621ea0f686e0bde3e4130e99116fd9d5:

Fixed #22347 -- Unified FileSystemStorage documentation.

Thanks nliberg for the report.

comment:4 Changed 16 months ago by Tim Graham <timograham@…>

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