Re: [Django] #22497: Documentation for deconstruct is wrong

2014-04-24 Thread Django
#22497: Documentation for deconstruct is wrong
---+--
 Reporter:  reames@…   |Owner:  nobody
 Type:  Uncategorized  |   Status:  new
Component:  Documentation  |  Version:  1.7-beta-2
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Unreviewed
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+--
Changes (by nliberg):

 * needs_better_patch:   => 0
 * needs_tests:   => 0
 * needs_docs:   => 0


Comment:

 I too was confused by this at first.
 For Fields a 4-tuple including the field name is returned. Documented
 here: https://docs.djangoproject.com/en/1.7/howto/custom-model-fields
 /#field-deconstruction
 For other custom classes a 3-tuple is returned. Documented here:
 https://docs.djangoproject.com/en/1.7/topics/migrations/#custom-
 deconstruct-method

 The latter text should probably mention and link to the former.

-- 
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 unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/087.abe41dc80f0663178de8c3205a693739%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.


[Django] #22497: Documentation for deconstruct is wrong

2014-04-23 Thread Django
#22497: Documentation for deconstruct is wrong
---+
 Reporter:  reames@…   |  Owner:  nobody
 Type:  Uncategorized  | Status:  new
Component:  Documentation  |Version:  1.7-beta-2
 Severity:  Normal |   Keywords:
 Triage Stage:  Unreviewed |  Has patch:  0
Easy pickings:  0  |  UI/UX:  0
---+
 I'm looking at the documentation on
 https://docs.djangoproject.com/en/1.7/topics/migrations/ for the
 `deconstruct()` method, where it states:

 It takes no arguments, and should return a tuple of 3 things: (path,
 args, kwargs).

 But, it actually should return 4 items as shown in the code:

 
https://github.com/django/django/blob/stable/1.7.x/django/db/migrations/state.py#L127

-- 
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 unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/072.52ad4d4ee6d6e87e2f479a113cdd6b37%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.