models.FileField links to url attribute, which is undocumented.
|Reported by:||Keryn Knight <keryn@…>||Owned by:||nobody|
|Severity:||Keywords:||filefield url easy-pickings|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
As part of the documentation callout on FileField.storage found in the Model Field Types documentation here, reference is made to the FileField.url attribute, which links to the documentation on the File class itself, where it is decidedly absent.
Following the rabbit hole from the original note on the modelfields through the Managing Files documentation, and on to the how-to on writing a custom storage backend (where a note is made that any custom solution must implement the url() method) we finally end up at the Storage API which does discuss the method.
It's a convoluted process, and I think the ref documentation on File should either document the attribute, or the model FileField reference should link to the documentation for the Storage API itself.
I can attempt to work up a documentation patch if the ticket has merit.
Change History (6)
comment:1 Changed 3 years ago by gabrielhurley
- milestone set to 1.3
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
- Triage Stage changed from Unreviewed to Accepted
Changed 3 years ago by Keryn Knight <keryn@…>
comment:3 Changed 3 years ago by gabrielhurley
- Resolution set to fixed
- Status changed from new to closed