Skip to content

Commit f09b084

Browse files
update docs
1 parent 3cb61ae commit f09b084

3 files changed

Lines changed: 13 additions & 6 deletions

File tree

docs/source/Exceptions.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,20 @@ Exceptions
66
==============================================================
77
AuthError
88
==============================================================
9-
.. autoclass:: polygon.websocket.__init__.AuthError
9+
.. autoclass:: polygon.exceptions.AuthError
1010
:members:
1111
:undoc-members:
1212

1313
==============================================================
1414
NoResultsError
1515
==============================================================
16-
.. autoclass:: polygon.rest.base.NoResultsError
16+
.. autoclass:: polygon.exceptions.NoResultsError
1717
:members:
18-
:undoc-members:
18+
:undoc-members:
19+
20+
==============================================================
21+
BadResponse
22+
==============================================================
23+
.. autoclass:: polygon.exceptions.BadResponse
24+
:members:
25+
:undoc-members:

polygon/exceptions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class AuthError(Exception):
1111
"""
1212
pass
1313

14-
class MissingResults(Exception):
14+
class NoResultsError(Exception):
1515
"""
1616
Missing results key
1717
"""

polygon/rest/base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import pkg_resources # part of setuptools
99
from ..logging import get_logger
1010
import logging
11-
from ..exceptions import AuthError, BadResponse, MissingResults
11+
from ..exceptions import AuthError, BadResponse, NoResultsError
1212

1313
logger = get_logger("RESTClient")
1414
version = "unknown"
@@ -83,7 +83,7 @@ def _get(
8383

8484
if result_key:
8585
if result_key not in obj:
86-
raise MissingResults(
86+
raise NoResultsError(
8787
f'Expected key "{result_key}" in response {obj}.'
8888
+ "Make sure you have sufficient permissions and your request parameters are valid."
8989
+ f"This is the url that returned no results: {resp.geturl()}"

0 commit comments

Comments
 (0)