Opened 6 months ago

Last modified 3 months ago

#28581 assigned Cleanup/optimization

Pagination topic docs need a little restructuring

Reported by: luto Owned by: luto
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description

During the Write The Docs conference I came a cross a few issues with the 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 Multiple object mixins as well as a very specific example in 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 :)

Change History (5)

comment:1 Changed 6 months ago by Claude Paroz

Triage Stage: UnreviewedAccepted
Type: BugCleanup/optimization

comment:2 Changed 3 months ago by Tim Martin

Has patch: unset

There is no patch yet AFAICS. If there is, please link it from the comments so that it can be reviewed.

comment:3 Changed 3 months ago by luto

The PR was already linked under "Pull Requests" in the main box, but here we go https://github.com/django/django/pull/9052 :) thanks for taking a look!

comment:4 Changed 3 months ago by Simon Charette

Has patch: set

comment:5 Changed 3 months ago by Tim Martin

Patch needs improvement: set

Sorry for the confusion - I'm new to the Django ticketing system and I don't think I've seen anyone use the ticket field for linking to PRs. People usually put them in the comments.

Anyway, the patch looks good to me. I flagged a couple of things for consideration on the pull request, but it's all subjective stuff so up to you if you want to leave it as it is.

Note: See TracTickets for help on using tickets.
Back to Top