#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 | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+--------------------
Specifically, [https://docs.djangoproject.com/en/dev/ref/django-admin
/#dumpdata-app-label-app-label-app-label-model dumpdata <app_label
app_label ...>] gives `--format`, `--pks`, `--indent` etc their own
headings, but `--exclude` and `--database` are formatted in such a way
that they look like addendums to the `--indent` documentation.
Also, `--pks` lacks a demonstrative example that `--format` and `--indent`
provide (eg: `<pk,pk,pk ...>` or whatever). I'd suggest that example
argument formats should also be given to `--exclude` and `--database`, if
hoisted to headings.
An argument could be made that because both are common options (documented
under common options) they needn't even be covered here, I suppose, though
given `dumpdata` exports unmanaged models (which it may not be able to)
I'd say the `--exclude` is pertinent. If hoisting to their own headings is
undesirable because they're already headings elsewhere, the paragraphs
should probably be moved to the preamble which includes explaining `--all`
as prose.
--
Ticket URL: <https://code.djangoproject.com/ticket/23868>
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/052.0998f2fab851ac917a63a5e4eb844c3a%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
