[Django] #32315: FileField.path is poorly documented

19 views
Skip to first unread message

Django

unread,
Jan 4, 2021, 12:42:31 PM1/4/21
to django-...@googlegroups.com
#32315: FileField.path is poorly documented
-----------------------------------------+------------------------
Reporter: ericloewe | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 3.1
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-----------------------------------------+------------------------
The FileField.path attribute is not documented in the
[[https://docs.djangoproject.com/en/3.1/ref/models/fields/#filefield|FileField
reference]], even though it is mentioned in
[[https://docs.djangoproject.com/en/3.1/topics/files/#using-files-in-
models|Managing files#using-files-in-models]].

I believe the same applies to ImageField, but have not tested it.

--
Ticket URL: <https://code.djangoproject.com/ticket/32315>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jan 4, 2021, 1:14:07 PM1/4/21
to django-...@googlegroups.com
#32315: Document FieldFile.path in docs/ref/models/fields.txt
--------------------------------------+------------------------------------
Reporter: Eric Loewenthal | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 3.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham):

* type: Uncategorized => Cleanup/optimization
* stage: Unreviewed => Accepted


Old description:

> The FileField.path attribute is not documented in the
> [[https://docs.djangoproject.com/en/3.1/ref/models/fields/#filefield|FileField
> reference]], even though it is mentioned in
> [[https://docs.djangoproject.com/en/3.1/topics/files/#using-files-in-
> models|Managing files#using-files-in-models]].
>
> I believe the same applies to ImageField, but have not tested it.

New description:

The `FieldFile.path` attribute is not documented in the

Managing files#using-files-in-models].

--

--
Ticket URL: <https://code.djangoproject.com/ticket/32315#comment:1>

Django

unread,
Jan 4, 2021, 2:56:19 PM1/4/21
to django-...@googlegroups.com
#32315: Document FieldFile.path in docs/ref/models/fields.txt
-------------------------------------+-------------------------------------
Reporter: Eric Loewenthal | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Hasan Ramezani):

* owner: nobody => Hasan Ramezani
* status: new => assigned


--
Ticket URL: <https://code.djangoproject.com/ticket/32315#comment:2>

Django

unread,
Jan 4, 2021, 3:01:54 PM1/4/21
to django-...@googlegroups.com
#32315: Document FieldFile.path in docs/ref/models/fields.txt
-------------------------------------+-------------------------------------
Reporter: Eric Loewenthal | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Hasan Ramezani):

* has_patch: 0 => 1


Comment:

[https://github.com/django/django/pull/13839 PR]

--
Ticket URL: <https://code.djangoproject.com/ticket/32315#comment:3>

Django

unread,
Jan 7, 2021, 6:52:36 AM1/7/21
to django-...@googlegroups.com
#32315: Document FieldFile.path in docs/ref/models/fields.txt
-------------------------------------+-------------------------------------
Reporter: Eric Loewenthal | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.1
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by GitHub <noreply@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"3eb98743dcaa0b7abd2d5832cba8cc9cb586a964" 3eb98743]:
{{{
#!CommitTicketReference repository=""
revision="3eb98743dcaa0b7abd2d5832cba8cc9cb586a964"
Fixed #32315 -- Doc'd FieldFile.path.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32315#comment:4>

Django

unread,
Jan 7, 2021, 6:53:59 AM1/7/21
to django-...@googlegroups.com
#32315: Document FieldFile.path in docs/ref/models/fields.txt
-------------------------------------+-------------------------------------
Reporter: Eric Loewenthal | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.1

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"2b443cb6c2d55669b20019f2755c0711c3d23050" 2b443cb]:
{{{
#!CommitTicketReference repository=""
revision="2b443cb6c2d55669b20019f2755c0711c3d23050"
[3.1.x] Fixed #32315 -- Doc'd FieldFile.path.

Backport of 3eb98743dcaa0b7abd2d5832cba8cc9cb586a964 from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32315#comment:5>

Reply all
Reply to author
Forward
0 new messages