Re: [Django] #15134: modelforms documentation appears twice in doctree

[Django]

#15134: modelforms documentation appears twice in doctree
-+--
   Reporter:  Aryeh Leib Taurog   | 
Owner:  nobody
 Status:  reopened   | 
Milestone:
  Component:  Documentation  |   
Version:  SVN   
 Resolution: |  
Keywords:
   Triage Stage:  Ready for checkin  | Has 
patch:  0 
Needs documentation:  0  |   Needs 
tests:  0 
Patch needs improvement:  0  |  
-+--
Changes (by Aryeh Leib Taurog ):

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


Comment:

 You clearly didn't read my last comment.

 This only about the **order** of the TOC entries in topics/forms/index

-- 
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] #15134: modelforms documentation appears twice in doctree

[Django]

#15134: modelforms documentation appears twice in doctree
-+--
   Reporter:  Aryeh Leib Taurog   | 
Owner:  nobody
 Status:  closed | 
Milestone:
  Component:  Documentation  |   
Version:  SVN   
 Resolution:  fixed  |  
Keywords:
   Triage Stage:  Ready for checkin  | Has 
patch:  0 
Needs documentation:  0  |   Needs 
tests:  0 
Patch needs improvement:  0  |  
-+--
Changes (by anonymous):

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


Comment:

 In this instance, I think Russ' fix was appropriate. The entry in the
 Topics index didn't belong there, its proper home is in the Forms index.

 While I agree that `ModelForms` and `ModelFormsets` are important, they
 are accessible from both the Forms index *and* from the front page of the
 docs ("forms for models"). I think this is sufficient for arriving at the
 correct location.

 To the point of "I suggest that [...] the toctree entry in
 topics/forms/index be [...] converted to a regular cross-reference link":
 That link is using Sphinx's auto-generated TOC mechanism, which creates a
 normal cross-reference. It just so happens that the second-level heading
 in that document is also marked as an inline code block (which is
 perfectly fine). That markup carries across to the TOC, hence the
 different appearance.

 I'm gonna re-close this as fixed, but thank you for your input Aryeh.

-- 
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] #15134: modelforms documentation appears twice in doctree

[Django]

#15134: modelforms documentation appears twice in doctree
-+--
   Reporter:  Aryeh Leib Taurog   | 
Owner:  nobody
 Status:  reopened   | 
Milestone:
  Component:  Documentation  |   
Version:  SVN   
 Resolution: |  
Keywords:
   Triage Stage:  Ready for checkin  | Has 
patch:  0 
Needs documentation:  0  |   Needs 
tests:  0 
Patch needs improvement:  0  |  
-+--
Changes (by Aryeh Leib Taurog ):

  * status:  closed => reopened
  * version:  1.2 => SVN
  * resolution:  fixed =>


Comment:

 I envisioned keeping the other TOC entry, as I detailed above.  However,
 if you're to keep the TOC entry here--and I admit this is more naturally
 implied by the file's location in the source tree--I suggest it be put
 **after** the TOC entry for !FormSets.  The reason for this is that an
 understanding of !FormSets is a prerequisite for understanding
 !ModelFormSets and !InlineModelFormsets, which are discussed in the
 !ModelForms section.

-- 
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] #15134: modelforms documentation appears twice in doctree

[Django]

#15134: modelforms documentation appears twice in doctree
-+--
   Reporter:  Aryeh Leib Taurog   | 
Owner:  nobody
 Status:  closed | 
Milestone:
  Component:  Documentation  |   
Version:  1.2   
 Resolution:  fixed  |  
Keywords:
   Triage Stage:  Ready for checkin  | Has 
patch:  0 
Needs documentation:  0  |   Needs 
tests:  0 
Patch needs improvement:  0  |  
-+--
Changes (by russellm):

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


Comment:

 (In [15366]) Fixed #15134 -- Removed a duplicate TOC entry for modelforms
 docs. Thanks to Aryeh Leib Taurog for the report.

-- 
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] #15134: modelforms documentation appears twice in doctree

[Django]

#15134: modelforms documentation appears twice in doctree
+---
  Reporter:  Aryeh Leib Taurog   | Owner:  
nobody
Status:  new| Milestone:

 Component:  Documentation  |   Version:  
1.2   
Resolution: |  Keywords:

 Stage:  Ready for checkin  | Has_patch:  0 

Needs_docs:  0  |   Needs_tests:  0 

Needs_better_patch:  0  |  
+---
Changes (by russellm):

  * stage:  Unreviewed => Ready for checkin

Comment:

 Marking RFC because the fix is a trivial 1 line deletion.

-- 
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] #15134: modelforms documentation appears twice in doctree

[Django]

#15134: modelforms documentation appears twice in doctree
+---
  Reporter:  Aryeh Leib Taurog   | Owner:  
nobody
Status:  new| Milestone:

 Component:  Documentation  |   Version:  
1.2   
Resolution: |  Keywords:

 Stage:  Unreviewed | Has_patch:  0 

Needs_docs:  0  |   Needs_tests:  0 

Needs_better_patch:  0  |  
+---
Changes (by Aryeh Leib Taurog ):

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

Comment:

 N.B. I checked for other cases of duplication in the docs and didn't find
 any

-- 
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] #15134: modelforms documentation appears twice in doctree

[Django]

#15134: modelforms documentation appears twice in doctree
---+
 Reporter:  Aryeh Leib Taurog   |   Owner:  nobody
   Status:  new|   Milestone:
Component:  Documentation  | Version:  1.2   
 Keywords: |   Stage:  Unreviewed
Has_patch:  0  |  
---+
 docs/topics/forms/modelforms.txt is included in the toctree from two
 locations:
  * docs/topics/index.txt
  * docs/topics/forms/index.txt

 This is confusing for the reader.

 I suggest that the toctree entry in topics/index be retained and the
 toctree entry in topics/forms/index be removed or converted to a regular
 cross-reference link.  The reasons I would prefer that are:
  1. ModelForms is sufficiently large, complex, and important a topic to
 warrant it's own section
  2. It will be easier to find in the docs if it has a 2nd-level heading
  3. It doesn't make sense to introduce ModelFormsets before introducing
 Formsets

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