#28581: Pagination topic docs need a little restructuring
-----------------------------------------+--------------------------
Reporter: luto | Owner: luto
Type: Bug | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 1
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-----------------------------------------+--------------------------
During the Write The Docs conference I came a cross a few issues with the
[https://docs.djangoproject.com/en/dev/topics/pagination/ pagination topic
documentation]. The content itself is great, but I think a little
restructuring could make it even better. Together with Daniele, we came
with the following changes:
* the topic page contains a full class reference to the `Paginator` class
as well as some helper classes. This should move to a new reference page.
* most developers will use a views `paginate_by` instead of the
`Paginator` class directly. This is documented in reference as part of
[https://docs.djangoproject.com/en/dev/ref/class-based-views/mixins-
multiple-object/ Multiple object mixins] as well as a very specific
example in [https://docs.djangoproject.com/en/dev/topics/class-based-
views/mixins/#using-singleobjectmixin-with-listview Class Based Views].
But there is no straight-forward example anywhere. The new page should
provide one and explain the behavior on a higher level.
Please note that this is my very first issue and pull request to django.
If any part of this does not comply with the way you usually do things,
just let me know and I'll happily adapt :)
--
Ticket URL: <https://code.djangoproject.com/ticket/28581>
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/047.dbae565d4060864e4e406835afa68fd5%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
