Code

Opened 2 years ago

Closed 2 years ago

#17794 closed Cleanup/optimization (fixed)

Docs should have more links to reference

Reported by: guettli Owned by: guettli
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 guettli 2 years ago.
Patch to docs/topics/db/queries.txt

Download all attachments as: .zip

Change History (6)

comment:1 in reply to: ↑ description Changed 2 years ago by ramiro

  • 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 2 years ago by ramiro (previous) (diff)

comment:2 Changed 2 years ago by guettli

  • Owner changed from nobody to guettli

Changed 2 years ago by guettli

Patch to docs/topics/db/queries.txt

comment:3 Changed 2 years ago by guettli

  • Easy pickings set
  • Has patch set
  • Triage Stage changed from Unreviewed to Ready for checkin

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

comment:4 Changed 2 years ago by claudep

  • Triage Stage changed from Ready for checkin to Accepted

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

comment:5 Changed 2 years ago by carljm

  • Resolution set to fixed
  • Status changed from new to closed

In [17624]:

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

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.