Code

Opened 5 years ago

Closed 4 years ago

Last modified 3 years ago

#12040 closed (fixed)

CurrentSiteManager documentation lacks indication when used in manytomany

Reported by: elpaso66 Owned by: gabrielhurley
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 gabrielhurley 4 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 4 years ago by russellm

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

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

  • Owner changed from nobody to copelco
  • Status changed from new to assigned

comment:3 Changed 4 years ago by copelco

  • Owner changed from copelco to nobody
  • Status changed from assigned to new

Changed 4 years ago by gabrielhurley

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

comment:4 Changed 4 years ago by gabrielhurley

  • Has patch set
  • Owner changed from nobody to gabrielhurley
  • Status changed from new to assigned

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

  • Triage Stage changed from Accepted to Ready for checkin

comment:6 Changed 4 years ago by russellm

  • Resolution set to fixed
  • Status changed from assigned to closed

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

(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 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.