Opened 5 years ago

Closed 5 years ago

#16469 closed Cleanup/optimization (fixed)

Improve the "internals" docs

Reported by: Aymeric Augustin 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


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 Aymeric Augustin 5 years ago.

Download all attachments as: .zip

Change History (3)

Changed 5 years ago by Aymeric Augustin

Attachment: 16469.diff added

comment:1 Changed 5 years ago by Julien Phalip

Triage Stage: UnreviewedReady for checkin

It looks pretty awesome to me.

comment:2 Changed 5 years ago by Jannis Leidel

Resolution: fixed
Status: newclosed

In [16548]:

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

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