Skip to content

Commit 3393269

Browse files
authored
A few API doc updates (#340)
* Added documentation for error codes * Updated API docs
1 parent 8373c21 commit 3393269

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

firebase_admin/exceptions.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@
1515
"""Firebase Exceptions module.
1616
1717
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.
1919
2020
:class:`FirebaseError` is the parent class of all exceptions raised by the Admin SDK. It contains
2121
the ``code``, ``http_response`` and ``cause`` properties common to all Firebase exception types.
2222
Each exception also carries a message that outlines what went wrong. This can be logged for
2323
audit or debugging purposes.
2424
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
2828
only a small subset of the available exception subtypes. However, the SDK also exposes rare error
2929
conditions like connection timeouts and other I/O errors as instances of ``FirebaseError``.
3030
Therefore it is always a good idea to have a handler specified for ``FirebaseError``, after all the

firebase_admin/messaging.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ def success(self):
295295

296296
@property
297297
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."""
299299
return self._exception
300300

301301

0 commit comments

Comments
 (0)