Opened 9 years ago

Closed 9 years ago

Last modified 8 years ago

#24359 closed Bug (fixed)

"Http exceptions are provided in django.http" links to a page that does not list or link to HTTP exceptions

Reported by: Daniel Greenfeld Owned by: nobody
Component: Documentation Version: 1.8alpha1
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Daniel Greenfeld)

Finding the list of HTTP exceptions via the documentation on any version of the Django documentation appears to be challenging.

References:

Change History (7)

comment:1 by Daniel Greenfeld, 9 years ago

Description: modified (diff)

comment:2 by Tim Graham, 9 years ago

The only documented exception seems to be UnreadablePostError. I guess we might add things like RawPostDataException and MultiPartParserError although we'd have to confirm there is a case for using them in code outside of Django itself.

The sentence "Http exceptions are provided in django.http." means that you can import the exceptions in this section from there, not that the linked page has information about them (like the rest of the sections on that page, but maybe this needs to be clarified... we could remove the links I suppose).

We are trying to redo the docs search using ElasticSearch if useless search results is part of your complaint.

comment:3 by Tim Graham, 9 years ago

Has patch: set
Triage Stage: UnreviewedAccepted

PR -- feedback welcome. We can create a separate ticket about documenting those other exceptions if needed.

comment:4 by Tim Graham <timograham@…>, 9 years ago

Resolution: fixed
Status: newclosed

In 2b19b3a031e7d5b5264bc9e880d0192301289bc2:

Fixed #24359 -- Cleaned up docs/ref/exceptions.html

comment:5 by Tim Graham <timograham@…>, 9 years ago

In 9d6f0dce139b5dc9ee019f16623e12c6579b45e3:

[1.8.x] Fixed #24359 -- Cleaned up docs/ref/exceptions.html

Backport of 2b19b3a031e7d5b5264bc9e880d0192301289bc2 from master

comment:6 by Pavel Savchenko, 8 years ago

I have a use case for adding documentation on RawPostDataException . I feel it would have helped me greatly if Django had this docstring in the Http Exceptions documenation (or even a mention in the HttpRequest docs).

Shall I open a new ticket or can we add a patch here?

Last edited 8 years ago by Pavel Savchenko (previous) (diff)

comment:7 by Tim Graham, 8 years ago

New ticket please.

Note: See TracTickets for help on using tickets.
Back to Top