Opened 7 years ago

Closed 5 years ago

#28581 closed Cleanup/optimization (fixed)

Pagination topic docs need a little restructuring

Reported by: luto Owned by: luto
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
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 (12)

comment:1 by Claude Paroz, 7 years ago

Triage Stage: UnreviewedAccepted
Type: BugCleanup/optimization

comment:2 by Tim Martin, 7 years ago

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 by luto, 7 years ago

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 by Simon Charette, 7 years ago

Has patch: set

comment:5 by Tim Martin, 7 years ago

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.

in reply to:  3 ; comment:6 by Nasir Hussain, 6 years ago

Replying to luto:
Hi Luto,

Are you still working on this one?

in reply to:  6 comment:7 by luto, 6 years ago

Are you still working on this one?

No, I am not. Sorry!

comment:8 by Mariusz Felisiak, 6 years ago

Owner: luto removed
Status: assignednew

comment:9 by Mariusz Felisiak, 5 years ago

Owner: set to armansabyr
Patch needs improvement: unset
Status: newassigned

comment:10 by Mariusz Felisiak, 5 years ago

Owner: changed from armansabyr to luto

comment:11 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

In 93b611c:

Refs #28581 -- Doc's how to paginate a ListView.

comment:12 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

Resolution: fixed
Status: assignedclosed

In d37ea5f0:

Fixed #28581 -- Moved django.core.paginator documentation to API Reference.

Co-Authored-By: Arman <armansabyrov@…>

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