[Django] #28581: Pagination topic docs need a little restructuring
Django
-----------------------------------------+--------------------------
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.
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Claude Paroz):
* type: Bug => Cleanup/optimization
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:1>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Martin):
* has_patch: 1 => 0
Comment:
There is no patch yet AFAICS. If there is, please link it from the
comments so that it can be reviewed.
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:2>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (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!
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:3>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Simon Charette):
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:4>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Martin):
* needs_better_patch: 0 => 1
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:5>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 1 | UI/UX: 0
Comment (by Nasir Hussain):
Replying to [comment:3 luto]:
Hi Luto,
Are you still working on this one?
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:6>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 1 | UI/UX: 0
Comment (by luto):
> Are you still working on this one?
No, I am not. Sorry!
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:7>
Django
Reporter: luto | Owner: (none)
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 1 | UI/UX: 0
Changes (by felixxm):
* owner: luto => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:8>
Django
Reporter: luto | Owner:
Type: | armansabyr
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 1 | UI/UX: 0
Changes (by armansabyr):
* owner: (none) => armansabyr
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:9>
Django
Reporter: luto | Owner: (none)
Type: Cleanup/optimization | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 1 | UI/UX: 0
Changes (by armansabyr):
* owner: armansabyr => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:10>
Django
Reporter: luto | Owner:
Type: | armansabyr
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 1 | UI/UX: 0
Changes (by armansabyr):
* owner: (none) => armansabyr
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:9>
Django
Reporter: luto | Owner:
Type: | armansabyr
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by felixxm):
* owner: (none) => armansabyr
* needs_better_patch: 1 => 0
* status: new => assigned
Comment:
[https://github.com/django/django/pull/11124 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:9>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by felixxm):
* owner: armansabyr => luto
Comment:
[https://github.com/django/django/pull/11535 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:10>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"d37ea5f09b81894cb3a55b000c98e94d80dfa6cf" d37ea5f0]:
{{{
#!CommitTicketReference repository=""
revision="d37ea5f09b81894cb3a55b000c98e94d80dfa6cf"
Fixed #28581 -- Moved django.core.paginator documentation to API
Reference.
Co-Authored-By: Arman <armans...@gmail.com>
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:12>
Django
Reporter: luto | Owner: luto
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"93b611c7971c521a4ed265fca663de3a7a4eb0b9" 93b611c]:
{{{
#!CommitTicketReference repository=""
revision="93b611c7971c521a4ed265fca663de3a7a4eb0b9"
Refs #28581 -- Doc's how to paginate a ListView.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28581#comment:11>