[Django] #24134: Deprecate short command line options for management commands?
Django
-------------------------------------+-------------------------------------
Reporter: mjtamlyn | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Core | Version: master
(Management commands) |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
We are very inconsistent with providing short options for command line
flags for management commands. For example, the options provided by the
test runner to `./manage.py test` all have short options, but the options
provided by the management command itself all do not. (`-t` means `--top-
level-directory`, but there is also `--testrunner` which has no
alternative).
I'm not sure what the correct course of action is but there should be some
consistency. Short options are patchily documented - some are, some are
not.
--
Ticket URL: <https://code.djangoproject.com/ticket/24134>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Reporter: mjtamlyn | Owner: nobody
Type: | Status: new
Cleanup/optimization |
commands) |
Severity: Normal | Resolution:
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 claudep):
OK to consistently document all options, short or long, but I don't see
the need to deprecate short options.
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:1>
Django
-------------------------------------+-------------------------------------
Reporter: mjtamlyn | Owner: nobody
Type: | Status: new
Cleanup/optimization |
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by freakboy3742):
Agreed that we should be documenting them consistently, and options should
be consistently used between commands, but I don't think it follows that
every option needs to have a short version, nor that we need to deprecate
short options entirely.
`-v` is a good example - it's convenient to be able to use `-v` instead of
`--verbose`; it's a commonly used option. But everywhere that --`verbose`
is available, `-v` is (or should be) the short option. But if a command
also had a `--very-important-flag-we-use-rarely`, the fact that there is a
collision on `-v` doesn't mean we should stop using it for the common
option, `--verbose`.
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:2>
Django
--------------------------------------+------------------------------------
Reporter: mjtamlyn | 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
Changes (by timgraham):
* stage: Unreviewed => Accepted
* component: Core (Management commands) => Documentation
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:3>
Django
--------------------------------------+------------------------------------
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by staeff):
* status: new => assigned
* owner: nobody => staeff
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:4>
Django
--------------------------------------+------------------------------------
Reporter: mjtamlyn | Owner: staeff
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by staeff):
I work on updating the documentation with the available but not yet
documented short versions.
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: mjtamlyn | Owner: staeff
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:6>
Django
--------------------------------------+------------------------------------
Reporter: mjtamlyn | Owner: staeff
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
Changes (by timgraham):
* needs_better_patch: 0 => 1
* has_patch: 0 => 1
* stage: Ready for checkin => Accepted
Comment:
The docs build doesn't pass with this change.
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:7>
Django
-------------------------------------+-------------------------------------
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: staeff => timgraham
Comment:
I'm working on this as part of #23868.
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: mjtamlyn | Owner: timgraham
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
Comment:
[https://github.com/django/django/pull/5971 PR] is ready for review.
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:9>
Django
-------------------------------------+-------------------------------------
Reporter: mjtamlyn | Owner: timgraham
Cleanup/optimization |
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"e519aab43a419589e92fe284e4ce2f2e034aec6a" e519aab4]:
{{{
#!CommitTicketReference repository=""
revision="e519aab43a419589e92fe284e4ce2f2e034aec6a"
Fixed #23868 -- Added support for non-unique django-admin-options in docs.
Also documented missing short command line options to fix #24134. This
bumps
the minimum sphinx version required to build the docs to 1.3.4.
Thanks Simon Charette for review.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:10>
Django
-------------------------------------+-------------------------------------
Reporter: mjtamlyn | Owner: timgraham
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Tim Graham <timograham@…>):
In [changeset:"d7a6086825d4a308955e792f65fdd9b5f714a505" d7a60868]:
{{{
#!CommitTicketReference repository=""
revision="d7a6086825d4a308955e792f65fdd9b5f714a505"
[1.9.x] Fixed #23868 -- Added support for non-unique django-admin-options
in docs.
Also documented missing short command line options to fix #24134. This
bumps
the minimum sphinx version required to build the docs to 1.3.4.
Thanks Simon Charette for review.
Backport of e519aab43a419589e92fe284e4ce2f2e034aec6a from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/24134#comment:11>