#19281: Modules to import in documentation
------------------------------------+--------------------
Reporter: krister.svanlund@… | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.4
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
------------------------------------+--------------------
The django documentation is very useful in a lot of ways but in my opinion
there is a problem when using it for reference. The module an object
belongs to is not printed out anywhere near it (except in some cases where
it is mentioned in the description). This makes it much harder than it
should have to be to use the django manual for reference. Today I learned
that the module is actually written out in the permalink for the object so
the data is apparently available when generating the docs.
'''My suggestion is''' that the documentation is changed so that objects
mentioned also clearly shows which module it belongs to without requiring
hovering and mentally parsing url. An alternative solution would be to
print this information in the beginning of a page on a form similar to
"The following objects belong to the module xxx.xxx.xxx if not otherwise
specified." I see the later suggestion as less satisfactory, both due to
it being printed separate from the actual object of interest and that I
believe it would take a lot more work to implement.
--
Ticket URL: <https://code.djangoproject.com/ticket/19281>
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 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 https://groups.google.com/groups/opt_out.
