#15396: full path to modules in documentation inconsistently referenced
-------------------------------+------------------------------------
Reporter: slinkp@… | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------
Comment (by EvilDMP):
I agree that simply turning on display of modules with `add_module_names`
would be a rather scattershot approach. Module names are not always
provided anyway.
I think that the best approach would be for code samples to include
imports, or at least the first one of a batch of them.
Similarly, if an object's path is not clear from its reasonably immediate
context, then it should be spelled out in full the first time it's
introduced in its reference documentation.
If there's a list of objects all from the same module, the module can be
mentioned once at the top of the list.
--
Ticket URL: <https://code.djangoproject.com/ticket/15396#comment:9>
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/074.795b53195a8b09beecf2e30eef20065b%40djangoproject.com.
For more options, visit https://groups.google.com/groups/opt_out.
