From bb390f51f0a41f858c473d5c1b8f25a78fdd2319 Mon Sep 17 00:00:00 2001 From: Roman Mogylatov Date: Mon, 25 Dec 2017 14:38:53 +0200 Subject: [PATCH] Add doc blocks for bundles example miniapp --- examples/miniapps/bundles/bundles/photos/entities.py | 5 ++++- examples/miniapps/bundles/bundles/photos/repositories.py | 5 +++++ examples/miniapps/bundles/bundles/users/entities.py | 5 +++++ examples/miniapps/bundles/bundles/users/repositories.py | 6 ++++++ 4 files changed, 20 insertions(+), 1 deletion(-) diff --git a/examples/miniapps/bundles/bundles/photos/entities.py b/examples/miniapps/bundles/bundles/photos/entities.py index ac8b0a62..173ace39 100644 --- a/examples/miniapps/bundles/bundles/photos/entities.py +++ b/examples/miniapps/bundles/bundles/photos/entities.py @@ -1,2 +1,5 @@ +"""Photos bundle entities module.""" + + class Photo(object): - pass + """Photo entity.""" diff --git a/examples/miniapps/bundles/bundles/photos/repositories.py b/examples/miniapps/bundles/bundles/photos/repositories.py index 6bd2b51b..710872ae 100644 --- a/examples/miniapps/bundles/bundles/photos/repositories.py +++ b/examples/miniapps/bundles/bundles/photos/repositories.py @@ -1,6 +1,11 @@ +"""Photos bundle entity repositories module.""" + + class PhotoRepository(object): + """Photo entity repository.""" def __init__(self, object_factory, fs, db): + """Initializer.""" self.object_factory = object_factory self.fs = fs self.db = db diff --git a/examples/miniapps/bundles/bundles/users/entities.py b/examples/miniapps/bundles/bundles/users/entities.py index f83a81fe..104dace4 100644 --- a/examples/miniapps/bundles/bundles/users/entities.py +++ b/examples/miniapps/bundles/bundles/users/entities.py @@ -1,4 +1,9 @@ +"""Users bundle entities module.""" + + class User(object): + """User entity.""" def __init__(self, id): + """Initializer.""" self.id = id diff --git a/examples/miniapps/bundles/bundles/users/repositories.py b/examples/miniapps/bundles/bundles/users/repositories.py index 97e8b392..d661a4c3 100644 --- a/examples/miniapps/bundles/bundles/users/repositories.py +++ b/examples/miniapps/bundles/bundles/users/repositories.py @@ -1,8 +1,14 @@ +"""Users bundle entity repositories module.""" + + class UserRepository(object): + """User entity repository.""" def __init__(self, object_factory, db): + """Initializer.""" self.object_factory = object_factory self.db = db def get(self, id): + """Return user entity with given identifier.""" return self.object_factory(id=id)