#30817: Document that Sitemap.items() can return an iterable.
--------------------------------------+------------------------------------
     Reporter:  Chris Jerdonek        |                    Owner:  nobody
         Type:  Cleanup/optimization  |                   Status:  new
    Component:  Documentation         |                  Version:  master
     Severity:  Normal                |               Resolution:
     Keywords:  sitemap               |             Triage Stage:  Accepted
    Has patch:  1                     |      Needs documentation:  0
  Needs tests:  0                     |  Patch needs improvement:  0
Easy pickings:  1                     |                    UI/UX:  0
--------------------------------------+------------------------------------

Comment (by Chris Jerdonek):

 Especially since `QuerySet` is a common case, it seems better to state it
 explicitly rather than leaving it as a puzzle for the reader to figure
 out.

 Even if the reader clicks on the glossary entry, the answer still isn't
 clear and leaves a subtle, nuanced questions. For example, the glossary
 entry says "an iterable which supports efficient element access using
 //integer// indices," but `QuerySet` objects don't support negative
 indices. So does that mean `QuerySet` objects aren't included? Rather than
 the reader having to sort through questions like these, the docs can be
 more helpful by simply stating it.

-- 
Ticket URL: <https://code.djangoproject.com/ticket/30817#comment:5>
Django <https://code.djangoproject.com/>
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 [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/067.14de4f94f4561c9b9de9601c66c36c1b%40djangoproject.com.

Reply via email to