Opened 5 years ago

Closed 5 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)

doc_links_topic_db_queries.patch (11.3 KB) - added by Thomas Güttler 5 years ago.
Patch to docs/topics/db/queries.txt

Download all attachments as: .zip

Change History (6)

comment:1 in reply to:  description Changed 5 years ago by Ramiro Morales

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset

Replying to guettli:

Dear core devs please decide if you want this or not.

Yes. See the the list here https://docs.djangoproject.com/en/dev/internals/contributing/writing-documentation/#improving-the-documentation in particular the fourth bullet.

If yes, this should be a easy picking.

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).

Last edited 5 years ago by Ramiro Morales (previous) (diff)

comment:2 Changed 5 years ago by Thomas Güttler

Owner: changed from nobody to Thomas Güttler

Changed 5 years ago by Thomas Güttler

Patch to docs/topics/db/queries.txt

comment:3 Changed 5 years ago by Thomas Güttler

Easy pickings: set
Has patch: set
Triage Stage: UnreviewedReady for checkin

I updated this file: docs/topics/db/queries.txt

comment:4 Changed 5 years ago by Claude Paroz

Triage Stage: Ready for checkinAccepted

Please do not mark your own patches as Ready for checkin.

comment:5 Changed 5 years ago by Carl Meyer

Resolution: fixed
Status: newclosed

In [17624]:

Fixed #17794 - Added a bunch of cross-reference links to the DB queries topic documentation. Thanks guettli for the initial patch.

Note: See TracTickets for help on using tickets.
Back to Top