[Django] #32475: datadump and dataload subcommands documentation error

6 views
Skip to first unread message

Django

unread,
Feb 22, 2021, 12:08:21 PM2/22/21
to django-...@googlegroups.com
#32475: datadump and dataload subcommands documentation error
-----------------------------------------+------------------------
Reporter: mslinn | Owner: nobody
Type: Bug | 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: 0
UI/UX: 0 |
-----------------------------------------+------------------------
Both the [https://docs.djangoproject.com/en/3.1/ref/django-admin/#dumpdata
datadump] and [https://docs.djangoproject.com/en/3.1/ref/django-
admin/#dataload dataload] subcommands have the same documentation error
regarding the `--database` option.

The documentation states that the option “Specifies the database from
which data will be dumped. Defaults to default.” Instead, the
documentation should say that the option “Specifies the named database
entry in settings. Defaults to default.”

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

Django

unread,
Feb 22, 2021, 2:09:49 PM2/22/21
to django-...@googlegroups.com
#32475: datadump and dataload subcommands documentation error
-------------------------------+--------------------------------------
Reporter: Mike Slinn | Owner: nobody
Type: Bug | Status: closed
Component: Documentation | Version: 3.1
Severity: Normal | Resolution: invalid

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by Mariusz Felisiak):

* status: new => closed
* resolution: => invalid


Comment:

Thanks for this ticket, however it's not an error. We use the same wording
throughout the docs, see
[https://docs.djangoproject.com/en/3.1/ref/settings/#databases DATABASES
docs]. IMO it's not misleading and "named" doesn't add much value.

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

Django

unread,
Feb 22, 2021, 3:46:24 PM2/22/21
to django-...@googlegroups.com
#32475: datadump and dataload subcommands documentation error
-------------------------------+--------------------------------------
Reporter: Mike Slinn | Owner: nobody
Type: Bug | Status: closed
Component: Documentation | Version: 3.1
Severity: Normal | Resolution: invalid

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------

Comment (by Mike Slinn):

The funny thing about computer documentation is that for someone who is
knowledgeable the information as presented is usually obvious. Newcomers,
however, have a completely different experience.

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

Reply all
Reply to author
Forward
0 new messages