#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.
--
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 post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/050.40463d93dff7409cbe31f3c96193a712%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
