Skip to content

Commit 46f837a

Browse files
jcugattomchristie
authored andcommitted
Fix APIException full_details() typo in documentation (encode#4633)
APIException has a get_full_details() method but the documentation refers to full_details().
1 parent eafc9a2 commit 46f837a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/api-guide/exceptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,15 @@ The available attributes and methods are:
119119

120120
* `.detail` - Return the textual description of the error.
121121
* `.get_codes()` - Return the code identifier of the error.
122-
* `.full_details()` - Return both the textual description and the code identifier.
122+
* `.get_full_details()` - Return both the textual description and the code identifier.
123123

124124
In most cases the error detail will be a simple item:
125125

126126
>>> print(exc.detail)
127127
You do not have permission to perform this action.
128128
>>> print(exc.get_codes())
129129
permission_denied
130-
>>> print(exc.full_details())
130+
>>> print(exc.get_full_details())
131131
{'message':'You do not have permission to perform this action.','code':'permission_denied'}
132132

133133
In the case of validation errors the error detail will be either a list or

0 commit comments

Comments
 (0)