Add errors module API docs
This commit is contained in:
parent
ec6bd0c2c1
commit
dc79339cae
|
@ -2,8 +2,21 @@
|
||||||
|
|
||||||
|
|
||||||
class Error(Exception):
|
class Error(Exception):
|
||||||
"""Base error."""
|
"""Base error.
|
||||||
|
|
||||||
|
All dependency injector errors extend this error class.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
class UndefinedProviderError(Error, AttributeError):
|
class UndefinedProviderError(Error, AttributeError):
|
||||||
"""Undefined provider error."""
|
"""Undefined provider error.
|
||||||
|
|
||||||
|
This error is used when provider could not be defined, for example:
|
||||||
|
|
||||||
|
- provider with certain name could not be defined
|
||||||
|
- catalog's name of the certain provider could not be defined
|
||||||
|
- etc...
|
||||||
|
|
||||||
|
Also this error extends standard :py:class:`AttributeError`. This gives
|
||||||
|
possibility to use it correctly with ``__getattr__()``.
|
||||||
|
"""
|
||||||
|
|
|
@ -2,4 +2,5 @@
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
.. automodule:: dependency_injector.errors
|
.. automodule:: dependency_injector.errors
|
||||||
:members:
|
:members:
|
||||||
|
:member-order: bysource
|
||||||
|
|
Loading…
Reference in New Issue