From c5c0fdbd05d6d6abf89677505ed05118c228a843 Mon Sep 17 00:00:00 2001 From: Roman Mogilatov Date: Wed, 2 Sep 2015 12:23:01 +0300 Subject: [PATCH] Update @di.inject() documentation --- docs/advanced_usage/index.rst | 16 ++++++++-------- .../advanced_usage/inject_decorator_flask.py | 2 +- .../advanced_usage/inject_decorator_simple.py | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/advanced_usage/index.rst b/docs/advanced_usage/index.rst index 18195577..83c9d053 100644 --- a/docs/advanced_usage/index.rst +++ b/docs/advanced_usage/index.rst @@ -8,21 +8,21 @@ Current section of documentation describes advanced usage of @inject decorator ----------------- -``@di.inject`` decorator can be used for making *inline* dependency injections. -It *patches* decorated callable in such way that dependency injection will be -done during every call of decorated callable. +``@di.inject()`` decorator can be used for making *inline* dependency +injections. It *patches* decorated callable in such way that dependency +injection will be done during every call of decorated callable. -``@di.inject`` decorator takes keyword argument, that will be injected during -every next call of decorated callback with the same name. Any Python object -will be injected *as is*, except ``di.Provider``'s, which will be called to -provide injectable values. +``@di.inject()`` decorator takes keyword argument, that will be injected +during every next call of decorated callback with the same name. Any Python +object will be injected *as is*, except ``di.Provider``'s, which will be +called to provide injectable values. Example: .. literalinclude:: ../../examples/advanced_usage/inject_decorator_simple.py :language: python -Example of usage ``@di.inject`` decorator with Flask: +Example of usage ``@di.inject()`` decorator with Flask: .. literalinclude:: ../../examples/advanced_usage/inject_decorator_flask.py :language: python diff --git a/examples/advanced_usage/inject_decorator_flask.py b/examples/advanced_usage/inject_decorator_flask.py index b4f209e8..5b1ae58f 100644 --- a/examples/advanced_usage/inject_decorator_flask.py +++ b/examples/advanced_usage/inject_decorator_flask.py @@ -1,4 +1,4 @@ -"""`@di.inject` decorator and Flask view example.""" +"""`@di.inject()` decorator and Flask view example.""" import sqlite3 import flask diff --git a/examples/advanced_usage/inject_decorator_simple.py b/examples/advanced_usage/inject_decorator_simple.py index bfa8194b..2a7fc468 100644 --- a/examples/advanced_usage/inject_decorator_simple.py +++ b/examples/advanced_usage/inject_decorator_simple.py @@ -1,4 +1,4 @@ -"""`@di.inject` decorator simple example.""" +"""`@di.inject()` decorator simple example.""" import dependency_injector as di