[Django] #22345: API documentation should show package name

5 views

Skip to first unread message

Django

unread,

Mar 26, 2014, 11:03:06 PM3/26/14

to django-...@googlegroups.com

#22345: API documentation should show package name
-------------------------------+--------------------
Reporter: poswald | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.6
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
Throughout the API, it can be very difficult to know which package you
need to import to get access to a class or function. Often this is encoded
into the permalink but not visible on the page. For example the anchor is:

https://docs.djangoproject.com/en/dev/ref/forms/fields/#django.forms.Field

but the class is described as:

class Field(**kwargs)

I think it would be best to list it as:

class django.forms.Field(**kwargs)

Or at least put the package name as a section header. I imagine there's a
way to make the documentation do this site-wide or at least for the API
section?

--
Ticket URL: <https://code.djangoproject.com/ticket/22345>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,

Mar 27, 2014, 6:07:59 AM3/27/14

to django-...@googlegroups.com

#22345: API documentation should show package name

Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------
Changes (by timo):

* status: new => closed
* needs_better_patch: => 0
* resolution: => duplicate
* needs_tests: => 0
* needs_docs: => 0