File tree Expand file tree Collapse file tree 2 files changed +5
-5
lines changed Expand file tree Collapse file tree 2 files changed +5
-5
lines changed Original file line number Diff line number Diff line change 15
15
"""Firebase Exceptions module.
16
16
17
17
This module defines the base types for exceptions and the platform-wide error codes as outlined in
18
- https://cloud.google.com/apis/deesign /errors.
18
+ https://cloud.google.com/apis/design /errors.
19
19
20
20
:class:`FirebaseError` is the parent class of all exceptions raised by the Admin SDK. It contains
21
21
the ``code``, ``http_response`` and ``cause`` properties common to all Firebase exception types.
22
22
Each exception also carries a message that outlines what went wrong. This can be logged for
23
23
audit or debugging purposes.
24
24
25
- When calling an Admin SDK API, developers may catch the parent ``FirebaseError`` and
26
- inspect its ``code`` to implement fine-grained error handling. Alternatively, developers may
27
- catch one or more subtypes of ``FirebaseError``. Under normal conditions, any given API may raise
25
+ When calling an Admin SDK API, developers can catch the parent ``FirebaseError`` and
26
+ inspect its ``code`` to implement fine-grained error handling. Alternatively, developers can
27
+ catch one or more subtypes of ``FirebaseError``. Under normal conditions, any given API can raise
28
28
only a small subset of the available exception subtypes. However, the SDK also exposes rare error
29
29
conditions like connection timeouts and other I/O errors as instances of ``FirebaseError``.
30
30
Therefore it is always a good idea to have a handler specified for ``FirebaseError``, after all the
Original file line number Diff line number Diff line change @@ -295,7 +295,7 @@ def success(self):
295
295
296
296
@property
297
297
def exception (self ):
298
- """A FirebaseError if an error occurs while sending the message to the FCM service."""
298
+ """A `` FirebaseError`` if an error occurs while sending the message to the FCM service."""
299
299
return self ._exception
300
300
301
301
You can’t perform that action at this time.
0 commit comments