#24656: Query Expressions page do not always show imports
--------------------------------------+------------------------------------
Reporter: pydanny | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Comment (by jarshwah):
Fully agree that examples should have imports shown and that the import
paths should be clear at either the top of the file or inline for each
type.
Regarding your linking to the source comment, are you referencing the
[source] annotations in some of the documentation? If so, those links
should only ever be supplementary for the curious, and absolutely not
required for complete understanding. I would disagree with the suggestion
that they should be removed if that's the suggestion being made. It's
entirely possible that I've misunderstood though.
If you have any other suggestions for improving the expressions
documentation, please raise them. Writing documentation for your own code
can be tricky, because you're not sure what is too little or too much
information sometimes.
--
Ticket URL: <https://code.djangoproject.com/ticket/24656#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 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/065.16b9410df6d327c4fd1ba324a488e2fa%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
