Opened 7 years ago

Closed 6 years ago

Last modified 5 years ago

#12040 closed (fixed)

CurrentSiteManager documentation lacks indication when used in manytomany

Reported by: elpaso66 Owned by: Gabriel Hurley
Component: Documentation Version: 1.1
Severity: Keywords: sites framework manager
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

http://docs.djangoproject.com/en/dev/ref/contrib/sites/

Should mention that the default field name for many-to-many is "sites" (plural) and not "site".

At least an example with m2m should show how to make it work:

on_site = CurrentSiteManager(field_name = 'sites')

Attachments (1)

12040_sites_docs.diff (3.9 KB) - added by Gabriel Hurley 7 years ago.
Cleans up the docs in that area and adds information about "sites" vs. "site"

Download all attachments as: .zip

Change History (9)

comment:1 Changed 7 years ago by Russell Keith-Magee

milestone: 1.2
Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedAccepted

There are also some markup problems around this area - the site attribute is marked up as the class Site, which could be confusing.

comment:2 Changed 7 years ago by Colin Copeland

Owner: changed from nobody to Colin Copeland
Status: newassigned

comment:3 Changed 7 years ago by Colin Copeland

Owner: changed from Colin Copeland to nobody
Status: assignednew

Changed 7 years ago by Gabriel Hurley

Attachment: 12040_sites_docs.diff added

Cleans up the docs in that area and adds information about "sites" vs. "site"

comment:4 Changed 7 years ago by Gabriel Hurley

Has patch: set
Owner: changed from nobody to Gabriel Hurley
Status: newassigned

I gave it my best go for cleaning up the docs there. Aside from noting about "sites" vs. "site" WRT ManyToManyFields and trying to sort out the all those :class: tags in there, I also corrected some awkward phrasings and bad line-wrapping.

comment:5 Changed 6 years ago by Russell Keith-Magee

Triage Stage: AcceptedReady for checkin

comment:6 Changed 6 years ago by Russell Keith-Magee

Resolution: fixed
Status: assignedclosed

(In [13168]) Fixed #12040 -- Cleaned up the documentation describing how CurrentSiteManager works. Thanks to elpaso66 for the report, and Gabriel Hurley for the draft patch.

comment:7 Changed 6 years ago by Russell Keith-Magee

(In [13174]) [1.1.X] Fixed #12040 -- Cleaned up the documentation describing how CurrentSiteManager works. Thanks to elpaso66 for the report, and Gabriel Hurley for the draft patch.

Backport of r13168 from trunk.

comment:8 Changed 5 years ago by Jacob

milestone: 1.2

Milestone 1.2 deleted

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