[Django] #29573: Internal links in docs missing: From topic guide to API ref
Django
------------------------------------------------+------------------------
Reporter: Thomas Güttler | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 2.0
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
It would be very nice, if there would be links from to topic guide to the
API reference.
concrete example: Link from
https://docs.djangoproject.com/en/2.0/topics/db/aggregation/#generating-
aggregates-for-each-item-in-a-queryset
to "annotate"
https://docs.djangoproject.com/en/2.0/ref/models/querysets/#annotate
--
Ticket URL: <https://code.djangoproject.com/ticket/29573>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Thomas Güttler | Owner: nobody
Type: Cleanup/optimization | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Carlton Gibson):
* version: 2.0 => master
* stage: Unreviewed => Accepted
Comment:
OK, yes. A link at the beginning of that section would seem
appropriate/useful.
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:1>
Django
--------------------------------------+------------------------------------
Reporter: Thomas Güttler | Owner: nobody
Type: Cleanup/optimization | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:2>
Django
--------------------------------------+------------------------------------
Type: Cleanup/optimization | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Damir Rakhimov):
OK, yes. A link at the beginning of that section would seem
appropriate/useful. (Carlton Gibson)
Is it enough just add link to **clause** in this statement ?
https://docs.djangoproject.com/en/2.0/topics/db/aggregation/#generating-
aggregates-for-each-item-in-a-queryset
Per-object summaries can be generated using the **annotate()**
[https://docs.djangoproject.com/en/2.0/ref/models/querysets/#annotate
clause].
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:3>
Django
Reporter: Thomas Güttler | Owner: Sunitha
Type: | Selvan
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 Sunitha Selvan):
* owner: nobody => Sunitha Selvan
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:4>
Django
-------------------------------------+-------------------------------------
Type: | Pathak
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 Vishvajit Pathak):
* owner: Sunitha Selvan => Vishvajit Pathak
* needs_docs: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Vishvajit
Type: | Pathak
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 Vishvajit Pathak):
* needs_docs: 1 => 0
* has_patch: 0 => 1
Comment:
[https://github.com/django/django/pull/10369 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Vishvajit
Type: | Pathak
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
Changes (by Carlton Gibson):
* needs_better_patch: 0 => 1
Comment:
Small cosmetic adjustments needed on the patch. Vishvajit please uncheck
'Patch needs improvement' when those are addressed.
Thanks for the input!
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:7>
Django
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Vishvajit
Type: | Pathak
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 Vishvajit Pathak):
* needs_better_patch: 1 => 0
Comment:
Cosmetic changes are added. Thanks Carlton for the review.
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Vishvajit
Type: | Pathak
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Carlton Gibson):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:9>
Django
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Vishvajit
Type: | Pathak
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"a48bc0cec9eaaf47c0b3de186c072cf00011c892" a48bc0c]:
{{{
#!CommitTicketReference repository=""
revision="a48bc0cec9eaaf47c0b3de186c072cf00011c892"
Fixed #29573 -- Added links in aggregation topic guide.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:10>
Django
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Vishvajit
Type: | Pathak
Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"56dd80e573f8ffd7bce3b8db4f51f92057c12b70" 56dd80e]:
{{{
#!CommitTicketReference repository=""
revision="56dd80e573f8ffd7bce3b8db4f51f92057c12b70"
[2.1.x] Fixed #29573 -- Added links in aggregation topic guide.
Backport of a48bc0cec9eaaf47c0b3de186c072cf00011c892 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29573#comment:11>