Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  ramiro
 Type:  Bug  |   Status:  closed
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:  fixed
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  0|UI/UX:  0
-+

Comment (by claudep):

 In [17833]:
 {{{
 #!CommitTicketReference repository="" revision="17833"
 [1.4.X] Fixed #17999 -- Restored the links to examples from models
 documentation. Refs #17605.

 Backport of r17832 from trunk.
 }}}

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  ramiro
 Type:  Bug  |   Status:  closed
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:  fixed
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  0|UI/UX:  0
-+

Comment (by claudep):

 In [17832]:
 {{{
 #!CommitTicketReference repository="" revision="17832"
 Fixed #17999 -- Restored the links to examples from models documentation.
 Refs #17605.
 }}}

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  ramiro
 Type:  Bug  |   Status:  closed
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:  fixed
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  0|UI/UX:  0
-+
Changes (by ubernostrum):

 * status:  assigned => closed
 * resolution:   => fixed


Comment:

 In [17737]:
 {{{
 #!CommitTicketReference repository="" revision="17737"
 Fixed #17605: Restored deleted query documentation that used to live in
 doctests. Thanks zsiciarz for work on the patch.
 }}}

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  ramiro
 Type:  Bug  |   Status:  assigned
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  0|UI/UX:  0
-+
Changes (by aaugustin):

 * needs_better_patch:  0 => 1


Comment:

 The style shows that these documents used to be doctests, but it's a good
 basis IMO.

 __topics/db/models.txt__

 * This page still refers to the "Many-to-one relationship model tests",
 but that link is pointing to a regular documentation page. Use the same
 wording as the other "See also" blocks?

 __topics/db/examples/many_to_one.txt__

 * `a = Article(id=None, ...`: this isn't idiomatic; I'd skip the `id`
 kwarg entirely.
 * "Article objects have access to their related Reporter objects:": this
 was demonstrated just above, I'd reorganize this part a bit
 * `>>> Article.objects.filter(reporter=1)`: I didn't know this was
 supported, and it feels unclean. Plus, there are two ways to do the same
 thing. Do we really want to document this possibility?
 * `>>> Reporter.objects.filter(article=1)`: same comment

 __topics/db/examples/many_to_many.txt__

 * "Add a Publication directly via publications.add...": shouldn't that be
 "publications.create"?
 * `>>> Article.objects.filter(publications=1)`: same comment again
 * `publications__in=[1,2]`: missing space after the comma
 * `publications__in=[p1,p2]`: missing space after the comma
 * `>>> Publication.objects.filter(article=1)`: same comment again
 * `article__in=[1,2]`: missing space after the comma
 * `article__in=[a1,a2]`: missing space after the comma
 * "After the delete, the QuerySet cache needs to be cleared, and the
 referenced objects should be gone": this sounds like an internal
 implementation detail, not something a developer using Django should worry
 about

 __topics/db/examples/one_to_one.txt__

 * "Restaurant.objects.all()" should be in fixed width font.

 I hope this helps!

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  ramiro
 Type:  Bug  |   Status:  assigned
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+
Changes (by ramiro):

 * needs_better_patch:  1 => 0


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  ramiro
 Type:  Bug  |   Status:  assigned
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  0|UI/UX:  0
-+
Changes (by ramiro):

 * owner:  nobody => ramiro
 * status:  new => assigned


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  nobody
 Type:  Bug  |   Status:  new
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  0|UI/UX:  0
-+

Comment (by zsiciarz):

 The second patch is a good starting point. However, in my opinion the
 examples should be simplified. There's too much tests for various field
 lookups which are already documented elsewhere. If these are meant to be
 '''examples''', they must be short, simple and useful. Also a few more
 lines of text would be welcome.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  nobody
 Type:  Bug  |   Status:  new
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  0|UI/UX:  0
-+
Changes (by zsiciarz):

 * needs_better_patch:  0 => 1


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  nobody
 Type:  Bug  |   Status:  new
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+

Comment (by ramiro):

 In the '-2' patch I simply converted to ReST syntax the models.py files of
 the modeltests for m2m, FK and one2one relationships freezing them with
 the state they were an the point their respective doctests were removed.

 Also, removed all references to `tests/modeltests/*` from
 `topics/db/models.txt`.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Re: [Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|Owner:  nobody
 Type:  Bug  |   Status:  new
Component:  Documentation|  Version:  1.3
 Severity:  Release blocker  |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+
Changes (by claudep):

 * needs_better_patch:   => 0
 * has_patch:  0 => 1
 * stage:  Unreviewed => Accepted
 * needs_tests:   => 0
 * needs_docs:   => 0


Comment:

 I added some code examples in the docs. Don't know if it is enough to
 cover most usages, but it's a start at least. Double-check my English, as
 usual.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

[Django] #17605: It is not documented how to work with ManyToMany relations

[Django]

#17605: It is not documented how to work with ManyToMany relations
-+
 Reporter:  kmike|  Owner:  nobody
 Type:  Bug  | Status:  new
Component:  Documentation|Version:  1.3
 Severity:  Release blocker  |   Keywords:
 Triage Stage:  Unreviewed   |  Has patch:  0
Easy pickings:  0|  UI/UX:  0
-+
 The docs for ManyToMany relations used to rely on doctests ("See the Many-
 to-many relationship model example for a full example.")
 https://docs.djangoproject.com/en/dev/topics/db/models/#many-to-many-
 relationships

 But since https://code.djangoproject.com/changeset/14285/ these doctests
 were removed. So ManyToMany relations are now almost undocumented (both in
 dev version of docs and in all old versions of docs).

 Because this is a regression from Django 1.3 I've marked it as a release
 blocker.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.