Skip to content

Commit e48dd8c

Browse files
adamtheturtleclaude
andcommitted
Use double backticks for result codes in exception docstrings
Replace single-quoted result code names with double backticks so the Sphinx spell checker treats them as inline code rather than words. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent c41af76 commit e48dd8c

File tree

2 files changed

+3
-6
lines changed

2 files changed

+3
-6
lines changed

spelling_private_dict.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
AuthenticationFailure
22
BadImage
3-
BadRequest
43
ConnectionErrorPossiblyImageTooLarge
54
DateRangeError
65
ImageTooLarge
76
InactiveProject
8-
InvalidAcceptHeader
9-
InvalidInstanceId
107
JSONDecodeError
118
MatchProcessing
129
MaxNumResultsOutOfRange

src/vws/exceptions/vws_exceptions.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,14 +174,14 @@ class TooManyRequestsError(VWSError): # pragma: no cover
174174
@beartype
175175
class InvalidAcceptHeaderError(VWSError): # pragma: no cover
176176
"""Exception raised when Vuforia returns a response with a result code
177-
'InvalidAcceptHeader'.
177+
``InvalidAcceptHeader``.
178178
"""
179179

180180

181181
@beartype
182182
class InvalidInstanceIdError(VWSError):
183183
"""Exception raised when Vuforia returns a response with a result code
184-
'InvalidInstanceId'.
184+
``InvalidInstanceId``.
185185
"""
186186

187187

@@ -190,5 +190,5 @@ class InvalidInstanceIdError(VWSError):
190190
@beartype
191191
class BadRequestError(VWSError): # pragma: no cover
192192
"""Exception raised when Vuforia returns a response with a result code
193-
'BadRequest'.
193+
``BadRequest``.
194194
"""

0 commit comments

Comments
 (0)