#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):
If it's going to say "sequence," I would suggest explicitly listing
`QuerySet` as an example (e.g. by adding "including `QuerySet`"
afterwards). The reason is that I don't think it's obvious whether or not
a `QuerySet` is considered a sequence, and `QuerySet` is the specific
thing I had a question about. For example, if the reader looks up Python's
definition of a sequence, it's not clear whether `QuerySet` supports all
of the "common sequence operations":
https://docs.python.org/3/library/stdtypes.html#common-sequence-operations
Like, concatenation is one of the operations, and concatenation isn't
documented in the `QuerySet` API:
https://docs.djangoproject.com/en/dev/ref/models/querysets/
--
Ticket URL: <https://code.djangoproject.com/ticket/30817#comment:3>
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.c5819bfc5eeacd39d004e6db64437a9c%40djangoproject.com.
