Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#13605 closed (fixed)

Storage.listdir() missing from the reference page

Reported by: kopernikus Owned by: elbarto
Component: Documentation Version: 1.2
Severity: Keywords: custom storage
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

http://docs.djangoproject.com/en/1.2/howto/custom-file-storage/ mentions Storage.listdir() as a required part of the interface but the linked reference page http://docs.djangoproject.com/en/1.2/ref/files/storage/#ref-files-storage lacks this method (and any description thereof ;))

On a related note: It would be nice if either of those pages would give some hints (or link to) how to USE the custom storage. Do one have to make an instance and pass it to every field? Can this go into settings.py or Meta?

thanks

Paul

Attachments (1)

listdir.diff (631 bytes) - added by elbarto 5 years ago.

Download all attachments as: .zip

Change History (6)

comment:1 Changed 5 years ago by russellm

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

Agreed -- the file storage API docs could be improved.

Changed 5 years ago by elbarto

comment:2 Changed 5 years ago by elbarto

  • Has patch set

comment:3 Changed 5 years ago by elbarto

  • Owner changed from nobody to elbarto

comment:4 Changed 5 years ago by gabrielhurley

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

(In [14831]) Fixed #13605 -- Improved documentation of the django.core.files.storage module. Added documentation for DefaultStorage, get_storage_class, FileSystemStorage, and some missing public methods on Storage. New metadata targets included for everything. Thanks to kopernikus for the report and elbarto for contributing to the patch.

comment:5 Changed 5 years ago by gabrielhurley

(In [14832]) [1.2.X] Fixed #13605 -- Improved documentation of the django.core.files.storage module. Added documentation for DefaultStorage, get_storage_class, FileSystemStorage, and some missing public methods on Storage. New metadata targets included for everything. Thanks to kopernikus for the report and elbarto for contributing to the patch.

Backport of [14831] from trunk.

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