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
Paginatorclass as well as some helper classes. This should move to a new reference page. - most developers will use a views
paginate_byinstead of thePaginatorclass 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 , 7 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|---|
| Type: | Bug → Cleanup/optimization |
comment:2 by , 6 years ago
| Has patch: | unset |
|---|
follow-up: 6 comment:3 by , 6 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 , 6 years ago
| Has patch: | set |
|---|
comment:5 by , 6 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.
follow-up: 7 comment:6 by , 5 years ago
Replying to luto:
Hi Luto,
Are you still working on this one?
comment:8 by , 5 years ago
| Owner: | removed |
|---|---|
| Status: | assigned → new |
There is no patch yet AFAICS. If there is, please link it from the comments so that it can be reviewed.