#23868: dumpdata options documentation isn't correctly formatted for some
options
--------------------------------------+------------------------------------
Reporter: kezabelle | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Comment (by akulakov):
I think it would make sense if common options would be always given either
before the specific options or after; it's better to have them before
specific options because otherwise they do look like they're part of the
option that precedes them.
Alternatively there may be a short paragraph before the first option that
simply lists the common option names and links to common options section.
The downside of this approach is that common options like --database and
--exclude are very important and perhaps deserve at least a short
description in each section. On the third hand, they are more or less
self-descriptive so perhaps they don't. A reader probably won't miss them
anyway since the name of the option is bolded.
--
Ticket URL: <https://code.djangoproject.com/ticket/23868#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/067.e63b6194048fb3e7dd4d4ff0ea2d85e0%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
