#32271: Documentation consistency between display views and edit views
------------------------------------------------+------------------------
Reporter: Carles Pina Estany | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 3.1
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
In the "generic display views" (https://docs.djangoproject.com/en/3.1/ref
/class-based-views/generic-
display/#django.views.generic.detail.DetailView) the example is:
{{{
class ArticleDetailView(DetailView):
}}}
In the "Generic editing views" (https://docs.djangoproject.com/en/3.1/ref
/class-based-views/generic-
editing/#django.views.generic.edit.CreateView.template_name_suffix) the
example is:
{{{
class AuthorCreate(CreateView):
}}}
(note that there is no `View` after `AuthorCreate`, like it was in the
`ArticleDetailView` example)
I was expecting it to be either:
{{{
class ArticleDetailView(DetailView)
class AuthorCreateView(CreateView)
}}}
or:
{{{
class ArticleDetail(DetailView)
class AuthorCreate(CreateView)
}}}
I'm happy to do a PR of any of the options. I'm slightly inclined for the
second one to keep it short and because usually these classes are in
`views.py`.
--
Ticket URL: <https://code.djangoproject.com/ticket/32271>
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/048.b85ed2afa5a000412e3bb4c69d0404c0%40djangoproject.com.
