Opened 14 years ago
Closed 14 years ago
#17794 closed Cleanup/optimization (fixed)
Docs should have more links to reference
| Reported by: | Thomas Güttler | Owned by: | Thomas Güttler | 
|---|---|---|---|
| Component: | Documentation | Version: | 1.3 | 
| Severity: | Normal | Keywords: | |
| Cc: | hv@… | Triage Stage: | Accepted | 
| Has patch: | yes | Needs documentation: | no | 
| Needs tests: | no | Patch needs improvement: | no | 
| Easy pickings: | yes | UI/UX: | no | 
Description
I think to documentation (like topic guides) should have more links to the references.
Example:
https://docs.djangoproject.com/en/dev/topics/db/queries/
To create an object, instantiate it using keyword arguments to the model class, then call **save()** to save it to
If save() would be a reference, it would be more easy to read the guide.
Dear core devs please decide if you want this or not. If yes, this should be a easy picking.
Attachments (1)
Change History (6)
comment:2 by , 14 years ago
| Owner: | changed from to | 
|---|
by , 14 years ago
| Attachment: | doc_links_topic_db_queries.patch added | 
|---|
Patch to docs/topics/db/queries.txt
comment:3 by , 14 years ago
| Easy pickings: | set | 
|---|---|
| Has patch: | set | 
| Triage Stage: | Unreviewed → Ready for checkin | 
I updated this file: docs/topics/db/queries.txt 
comment:4 by , 14 years ago
| Triage Stage: | Ready for checkin → Accepted | 
|---|
Please do not mark your own patches as Ready for checkin.
  Note:
 See   TracTickets
 for help on using tickets.
    
Replying to guettli:
Yes. See the the list here https://docs.djangoproject.com/en/dev/internals/contributing/writing-documentation/#improving-the-documentation in particular the fourth bullet.
Patches to our docs are always welcome :)
Do you intend to implement further action for this ticket? If the answer is yes please do so, otherwise please close it because it reports something that is a known work-in-progress task for the community at large (including the development team).