#34224: App name in help text of commands is missing context
-------------------------------------+-------------------------------------
Reporter: David | Owner: nobody
Type: New | Status: new
feature |
Component: Core | Version: 4.1
(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 |
-------------------------------------+-------------------------------------
In the help text shown by `python manage.py help`, only the last part
(after the last dot) of the app name is shown. See
ManagementUtility.main_help_text.
Imagine a project that implements multiple apps; more than one of which
defines custom commands:
- project.core
- project.app1
- project.appN
These might show up as:
{{{
[appN]
command_one
command_two
[auth]
...
[contenttypes]
...
[core]
command_one
command_two
}}}
There are problems with this: It is not clear what "core", "appN" and so
on, refer to, as they are missing the "project" context. And I don't think
it is reasonable to assume that everybody who deploys this project will
know by heart which of the apps belong to "project" and which don't. Due
to the alphabetical sorting, apps belonging to the "project" are not
grouped together which makes it more difficult to find relevant commands.
In this example it would be nice to see this instead:
{{{
[django.contrib.auth]
...
[django.contrib.contenttypes]
...
[project.appN]
command_one
command_two
[project.core]
command_one
command_two
}}}
I think it would be beneficial to either allow the developer of an app to
decide what is shown here, and/or show the full module/package name (by
default). I'm sure both of these approaches also have drawbacks. I could
imagine app names being quite long (even django.contrib.contenttypes is
quite long already). Also people might try to "shadow" existing names.
--
Ticket URL: <https://code.djangoproject.com/ticket/34224>
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 view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/01070185396268f2-a860655f-64c5-4026-aa8f-00bcfe0357d3-000000%40eu-central-1.amazonses.com.
