#30417: Documentation missing for TemplateCommand
-------------------------------------+-------------------------------------
Reporter: Christian | Owner: nobody
González |
Type: | Status: new
Cleanup/optimization |
Component: Database | Version: 2.2
layer (models, ORM) |
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 |
-------------------------------------+-------------------------------------
Although it is an official command in Django (ok, it is inherited by e.g.
startproject), there is no documentation I could find in the docs about
TemplateCommand. It would be good to mention it on
https://docs.djangoproject.com/en/2.2/howto/custom-management-commands
/#basecommand-subclasses - others are mentioned there. A few lines would
suffice:
class TemplateCommand
A management command which creates a directory structure within a
Django application using templates
TemplateCommand.handle(app_or_project, name, target=None, **options)
app_or_project: The string 'app' or 'project'.
name: The name of the application or project.
directory: The directory to which the template should be copied.
options: The additional variables passed to project or app templates
This is mostly copied from the TemplateCommand docstring. Note that
"directory" was renamed into "target" as __init__ method's parameter, but
kept as "directory" in the command argument (for compatibility reasons?).
--
Ticket URL: <https://code.djangoproject.com/ticket/30417>
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/049.7f07004955bad092e525ad35c8d26cdb%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
