Code

Opened 4 years ago

Closed 4 years ago

Last modified 3 years ago

#12880 closed (fixed)

Structural documentation fix: unqualified method directives

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

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 psagers 4 years ago.
rev 12438
12880.diff (1.0 KB) - added by timo 4 years ago.
patch using currentmodule directive

Download all attachments as: .zip

Change History (6)

Changed 4 years ago by psagers

rev 12438

comment:1 Changed 4 years ago by russellm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Changed 4 years ago by timo

patch using currentmodule directive

comment:2 Changed 4 years ago by timo

  • Triage Stage changed from Accepted to 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 Changed 4 years ago by russellm

  • Resolution set to fixed
  • Status changed from new to 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 Changed 3 years ago by jacob

  • milestone 1.2 deleted

Milestone 1.2 deleted

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.