From d573c990b0b91a42044dea34b1c088893dbe9602 Mon Sep 17 00:00:00 2001 From: Roman Mogylatov Date: Tue, 1 Sep 2020 16:56:05 -0400 Subject: [PATCH] Edit object docs --- docs/main/changelog.rst | 5 ++--- docs/providers/object.rst | 15 +++++++++------ examples/providers/object.py | 10 +++++----- 3 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/main/changelog.rst b/docs/main/changelog.rst index 531b44ac..e9168312 100644 --- a/docs/main/changelog.rst +++ b/docs/main/changelog.rst @@ -9,9 +9,8 @@ follows `Semantic versioning`_ Development version ------------------- -- Update ``Singleton`` provider documentation and rework examples. -- Update ``Callable`` provider documentation and rework examples. -- Update ``Coroutine`` provider documentation and rework examples. +- Update documentation and rework examples for: ``Singleton``, ``Callable``, ``Coroutine``, + ``Object`` providers. 3.34.0 ------ diff --git a/docs/providers/object.rst b/docs/providers/object.rst index 6599dd92..800b8116 100644 --- a/docs/providers/object.rst +++ b/docs/providers/object.rst @@ -1,14 +1,17 @@ -Object providers ----------------- +Object provider +--------------- + +.. meta:: + :keywords: Python,DI,Dependency injection,IoC,Inversion of Control,Object + :description: Object provider provides an object "as is". This page demonstrates how to use an + Object provider. .. currentmodule:: dependency_injector.providers -:py:class:`Object` provider returns provided instance "as is". - -Example: +:py:class:`Object` provider returns an object "as is". .. literalinclude:: ../../examples/providers/object.py :language: python - + :lines: 3- .. disqus:: diff --git a/examples/providers/object.py b/examples/providers/object.py index f3fa6693..7da9cb26 100644 --- a/examples/providers/object.py +++ b/examples/providers/object.py @@ -1,10 +1,10 @@ -"""Object providers example.""" +"""`Object` provider example.""" -import dependency_injector.providers as providers +from dependency_injector import providers -# Creating object provider: object_provider = providers.Object(1) -# Making some asserts: -assert object_provider() == 1 + +if __name__ == '__main__': + assert object_provider() == 1