Opened 6 years ago

Closed 6 years ago

Last modified 4 years ago

#12834 closed (wontfix)

"self" missing from Database Router signatures in docs

Reported by: adamv 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:


In the Database Router docs, "self" is missing from the method signatures.

Attachments (1)

multi.diff (1.5 KB) - added by adamv 6 years ago.

Download all attachments as: .zip

Change History (7)

Changed 6 years ago by adamv

comment:1 Changed 6 years ago by adamv

  • Component changed from Uncategorized to Documentation
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 6 years ago by adamv

  • Version changed from 1.1 to 1.2-beta

comment:3 Changed 6 years ago by Alex

  • Triage Stage changed from Unreviewed to Ready for checkin

comment:4 Changed 6 years ago by Alex

  • milestone set to 1.2

comment:5 Changed 6 years ago by jacob

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

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 4 years ago by jacob

  • milestone 1.2 deleted

Milestone 1.2 deleted

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