[Django] #22347: FileSystemStorage documentation spread out in different places

[Django]

#22347: FileSystemStorage documentation spread out in different places
--------------------------------------+-------------------------------
Reporter: nliberg | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords: FileSystemStorage
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+-------------------------------
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.

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

[Django]

#22347: FileSystemStorage documentation spread out in different places

--------------------------------------+------------------------------------

Reporter: nliberg | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master

Severity: Normal | Resolution:
Keywords: FileSystemStorage | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by timo):

* needs_docs: => 0
* needs_better_patch: => 0
* needs_tests: => 0
* stage: Unreviewed => Accepted

Comment:

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.

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

[Django]

#22347: FileSystemStorage documentation spread out in different places

--------------------------------------+------------------------------------
Reporter: nliberg | Owner: vlal
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

Severity: Normal | Resolution:
Keywords: FileSystemStorage | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by vlal):

* cc: vlal (added)
* owner: nobody => vlal
* has_patch: 0 => 1
* status: new => assigned

Comment:

Issued [https://github.com/django/django/pull/2506 Pull Request #2506].
Verified documentation builds properly.

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

[Django]

#22347: FileSystemStorage documentation spread out in different places

--------------------------------------+------------------------------------
Reporter: nliberg | Owner: vlal

Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed

Keywords: FileSystemStorage | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Tim Graham <timograham@…>):

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

Comment:

In [changeset:"ca93f02c621ea0f686e0bde3e4130e99116fd9d5"]:
{{{
#!CommitTicketReference repository=""
revision="ca93f02c621ea0f686e0bde3e4130e99116fd9d5"
Fixed #22347 -- Unified FileSystemStorage documentation.

Thanks nliberg for the report.
}}}

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

[Django]

#22347: FileSystemStorage documentation spread out in different places

--------------------------------------+------------------------------------
Reporter: nliberg | Owner: vlal
Type: Cleanup/optimization | Status: closed

Component: Documentation | Version: master

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

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------

Comment (by Tim Graham <timograham@…>):

In [changeset:"36d1e3725fd0b6a196ddb662fd1eb8bca638d38c"]:
{{{
#!CommitTicketReference repository=""
revision="36d1e3725fd0b6a196ddb662fd1eb8bca638d38c"
[1.7.x] Fixed #22347 -- Unified FileSystemStorage documentation.

Thanks nliberg for the report.

Backport of ca93f02c62 from master
}}}

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