From d3d170620a9a4a8db1d8958bf4967bbdad5e53f3 Mon Sep 17 00:00:00 2001 From: Roman Mogilatov Date: Tue, 18 Apr 2017 23:38:04 +0300 Subject: [PATCH] Fix few pydocstyle errors in examples --- docs/main/changelog.rst | 1 + examples/miniapps/movie_lister/example/main.py | 2 +- examples/providers/singleton_thread_locals.py | 2 +- examples/speech/inject.py | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/main/changelog.rst b/docs/main/changelog.rst index 4c4367ec..5d4dba0c 100644 --- a/docs/main/changelog.rst +++ b/docs/main/changelog.rst @@ -14,6 +14,7 @@ Development version ``Provider.override(provider)``, ``Provider.reset_last_overriding()``, ``Provider.reset_override()``. - Refactor storage locking of ``ThreadSafeSingleton`` provider. +- Fix few ``pydocstyle`` errors in examples. 3.4.1 ----- diff --git a/examples/miniapps/movie_lister/example/main.py b/examples/miniapps/movie_lister/example/main.py index 26a51f63..c029226b 100644 --- a/examples/miniapps/movie_lister/example/main.py +++ b/examples/miniapps/movie_lister/example/main.py @@ -2,7 +2,7 @@ def main(movie_lister): - """Main function. + """Run application. This program prints info about all movies that were directed by different persons and then prints all movies that were released in 2015. diff --git a/examples/providers/singleton_thread_locals.py b/examples/providers/singleton_thread_locals.py index b25e22d7..5822a3ab 100644 --- a/examples/providers/singleton_thread_locals.py +++ b/examples/providers/singleton_thread_locals.py @@ -7,7 +7,7 @@ import dependency_injector.providers as providers def example(example_object, queue): - """Example function that puts provided object in the provided queue.""" + """Put provided object in the provided queue.""" queue.put(example_object) diff --git a/examples/speech/inject.py b/examples/speech/inject.py index 963ed799..bd118925 100644 --- a/examples/speech/inject.py +++ b/examples/speech/inject.py @@ -8,7 +8,7 @@ from dependency_injector.injections import inject @inject(car_factory=Container.car_factory.delegate()) @inject(extra_engine=Container.engine_factory) def main(car_factory, extra_engine): - """Main function.""" + """Run application.""" car1 = car_factory(serial_number=1) car2 = car_factory(serial_number=2, engine=extra_engine)