Code

Opened 3 years ago

Closed 3 years ago

#16469 closed Cleanup/optimization (fixed)

Improve the "internals" docs

Reported by: aaugustin Owned by: nobody
Component: Documentation Version: 1.3
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

I proof-read all docs/internals, fixing typos, updating outdated links, adding some headers, and rewriting paragraphs that weren't consistent — either internally or with the current state of things.

Here are the notable changes:

  • I added a paragraph to highlight the fact that producing code is not the only way to contribute to Django. Helping other users is also very important, as it frees up core developers time.
  • I documented the new backport policy, as described in Jacob's email a few weeks ago.
  • I rewrote unrealistic backwards-compatibility claims.
  • I consistently recommended to ask for new features on django-developers: in some places, I found sentences that boiled down to "ask for new features on Trac", although the paragraph dedicated to new features says to ask of the mailing list first.
  • I suggested to check for unused imports before submitting a patch, to reduce the need for r16539 style cleanup.

Note to reviewers: I re-indented deprecation.txt entirely to add navigable headers, but I didn't touch its content at all.

Attachments (1)

16469.diff (65.5 KB) - added by aaugustin 3 years ago.

Download all attachments as: .zip

Change History (3)

Changed 3 years ago by aaugustin

comment:1 Changed 3 years ago by julien

  • Triage Stage changed from Unreviewed to Ready for checkin

It looks pretty awesome to me.

comment:2 Changed 3 years ago by jezdez

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

In [16548]:

Fixed #16469 -- Improved documentation of Django internals, including the new backport policy. Many thanks to Aymeric Augustin.

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.