#29573 closed Cleanup/optimization (fixed)
Add link from per-item aggregation topic discussion to `annotate()` ref.
| Reported by: | Thomas Güttler | Owned by: | Vishvajit Pathak |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
It would be very nice, if there would be links from to topic guide to the API reference.
concrete example: Link from
to "annotate"
https://docs.djangoproject.com/en/2.0/ref/models/querysets/#annotate
Change History (11)
comment:1 by , 6 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|---|
| Version: | 2.0 → master |
comment:2 by , 6 years ago
| Summary: | Internal links in docs missing: From topic guide to API ref → Add link from per-item aggregation topic discussion to `annotate()` ref. |
|---|
comment:3 by , 6 years ago
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() clause.
comment:4 by , 6 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:5 by , 6 years ago
| Needs documentation: | set |
|---|---|
| Owner: | changed from to |
comment:7 by , 6 years ago
| Patch needs improvement: | set |
|---|
Small cosmetic adjustments needed on the patch. Vishvajit please uncheck 'Patch needs improvement' when those are addressed.
Thanks for the input!
comment:8 by , 6 years ago
| Patch needs improvement: | unset |
|---|
Cosmetic changes are added. Thanks Carlton for the review.
comment:9 by , 6 years ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
OK, yes. A link at the beginning of that section would seem appropriate/useful.