Opened 7 years ago

Closed 7 years ago

Last modified 5 years ago

#12834 closed (wontfix)

"self" missing from Database Router signatures in docs

Reported by: Adam Vandenberg Owned by: nobody
Component: Documentation Version: 1.2-beta
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 Database Router docs, "self" is missing from the method signatures.

Attachments (1)

multi.diff (1.5 KB) - added by Adam Vandenberg 7 years ago.

Download all attachments as: .zip

Change History (7)

Changed 7 years ago by Adam Vandenberg

Attachment: multi.diff added

comment:1 Changed 7 years ago by Adam Vandenberg

Component: UncategorizedDocumentation

comment:2 Changed 7 years ago by Adam Vandenberg

Version: 1.11.2-beta

comment:3 Changed 7 years ago by Alex Gaynor

Triage Stage: UnreviewedReady for checkin

comment:4 Changed 7 years ago by Alex Gaynor

milestone: 1.2

comment:5 Changed 7 years ago by Jacob

Resolution: wontfix
Status: newclosed

The standard style in our docs is to omit the self argument when documenting method signatures (see all the other uses of .. method:: in the docs. This is because we're documenting how a user would call the method, not how it's actually implemented.

comment:6 Changed 5 years ago by Jacob

milestone: 1.2

Milestone 1.2 deleted

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