Opened 14 years ago

Closed 14 years ago

Last modified 13 years ago

#12880 closed (fixed)

Structural documentation fix: unqualified method directives

Reported by: Peter Sagerson Owned by: nobody
Component: Documentation Version: dev
Severity: 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

In the documentation, there are a few references to methods in django.contrib.backends.RemoteUserBackend and django.db.transaction that are not fully qualified. Sphinx therefore places them at the top of the namespace instead of where they belong.

Attachments (2)

qualified_names.diff​ (2.2 KB ) - added by Peter Sagerson 14 years ago.
rev 12438
12880.diff​ (1.0 KB ) - added by Tim Graham 14 years ago.
patch using currentmodule directive

Download all attachments as: .zip

Change History (6)

by Peter Sagerson, 14 years ago

Attachment: qualified_names.diff​ added

rev 12438

comment:1 by Russell Keith-Magee, 14 years ago

Triage Stage: Unreviewed → Accepted

by Tim Graham, 14 years ago

Attachment: 12880.diff​ added

patch using currentmodule directive

comment:2 by Tim Graham, 14 years ago

Triage Stage: Accepted → Ready for checkin

I added an alternate patch which uses the currentmodule directive, a bit cleaner I think. I also tested that creating links to the elements in the affected pages works as expected with this patch.

comment:3 by Russell Keith-Magee, 14 years ago

Resolution: → fixed
Status: new → closed

(In [12559]) Fixed #12880 -- Added some missing sphinx directives for module references. Thanks to psagers for the report, and timo for the patch.

comment:4 by Jacob, 13 years ago

milestone: 1.2

Milestone 1.2 deleted

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