diff options
| author | Matthew J Morrison | 2014-09-17 07:49:54 -0500 | 
|---|---|---|
| committer | Matthew J Morrison | 2014-09-17 07:49:54 -0500 | 
| commit | e5af0bbb353e772473b1d9fcfc896bfd7365db2a (patch) | |
| tree | 2129b68f9c0e61b80444c2e153bbee4ebb2c96a8 | |
| parent | 92fb08bc6d66c33e7b4ea6689b300cf83e0b06d8 (diff) | |
| download | django-rest-framework-e5af0bbb353e772473b1d9fcfc896bfd7365db2a.tar.bz2 | |
Clarify "raised inside REST framework"
I ran into an issue today where I was not seeing the rest_framework.views.exception_handler do what I thought it should be doing. It turned out that I had imported View from rest_framework.views rather than importing APIView from rest_framework.views. The phrase "raised inside REST framework" was confusing as I was debugging this issue. I was unsure if that meant that I could raise those exceptions in my code or if it had to originate from within framework code.
I'm not sure if the proposed wording is ideal, I just wanted to point out what I found to be confusing.
| -rw-r--r-- | docs/api-guide/exceptions.md | 2 | 
1 files changed, 1 insertions, 1 deletions
| diff --git a/docs/api-guide/exceptions.md b/docs/api-guide/exceptions.md index 66e18173..33c4dc91 100644 --- a/docs/api-guide/exceptions.md +++ b/docs/api-guide/exceptions.md @@ -84,7 +84,7 @@ Note that the exception handler will only be called for responses generated by r  **Signature:** `APIException()` -The **base class** for all exceptions raised inside REST framework. +The **base class** for all exceptions raised inside an APIView class or @api_view.  To provide a custom exception, subclass `APIException` and set the `.status_code` and `.default_detail` properties on the class. | 
