#20786 closed Uncategorized (fixed)
Importing exceptions: documentation should be more explicit and clearer
Reported by: | Daniele Procida | Owned by: | Dominic Rodger |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | internet@… | Triage Stage: | Accepted |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
At https://docs.djangoproject.com/en/dev/ref/exceptions, for some of the listed exceptions information is provided on how to import it.
For example: "The UnreadablePostError is raised when a user cancels an upload. It is available from django.http."
For others though (e.g. https://docs.djangoproject.com/en/dev/ref/exceptions/#noreversematch) there isn't clear explicit information about where to get them from.
Also, when the information is provided, it's not always provided consistently.
My suggestion is that each section (Database Exceptions, Http Exceptions and so on) there should begin with a paragraph on its own: Core exceptions are provided in django.core.exceptions, Database exceptions are provided in django.db and so on.
FInally, Django-specific Exceptions seems a bit of a misnomer, since others not in that section are also Django-specific. Calling them Core exceptions would seem to make more sense.
Change History (6)
comment:1 by , 11 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:2 by , 11 years ago
Cc: | added |
---|---|
Owner: | changed from | to
Status: | new → assigned |
comment:3 by , 11 years ago
Has patch: | set |
---|---|
Version: | 1.5 → master |
Pull request created at https://github.com/django/django/pull/1425.
There are a couple of extra commits in the pull request that tidy up two other things on this page (one typo, and the section on DoesNotExist). I'll happily separate those out into a separate pull request if that'd be easier.
Do let me know if there's anything else I can do to make getting this merged easier, this is my first (non-single-line!) submission to Django.
comment:4 by , 11 years ago
I'm taking a look at your pull request now. Eventually, your commits should be collapsed into one, which will require a git rebase. There's no reason to make multiple pull requests.
Anyway, it looks fundamentally good; I'll send you a pull request myself if I think any minor tweaks to your improvements are required.
comment:5 by , 11 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
This has bugged me in the past too - I'll take a look at fixing it.