Merge pull request #24 from masterdatascience-UIMP-UC/docstrings

Fix Docstrings fixes issue #19

openapi_server/controllers/__init__.py

@@ -0,0 +1,7 @@
+"""
+
+PredictaaS is a app aimed to become the central platforn for ML in the EOSC.
+
+It takes input data from the user, runs it through a Machine Learning (ML) model and produces a prediction/result.
+
+"""

openapi_server/controllers/app_controller.py

@@ -1,10 +1,19 @@
+"""
+
+Main code.
+
+Gets the ML application and Updates it.
+
+"""
+
 from aiohttp import web
 
 from openapi_server.models.ml_app import MLApp
 
 
 async def get_ml_app_by_name(request: web.Request, appname) -> web.Response:
-    """Get ML application by name
+    """
+    Get ML application by name.
 
     Some description of the operation. You can use `markdown` here.
 
@@ -16,7 +25,8 @@ async def get_ml_app_by_name(request: web.Request, appname) -> web.Response:
 
 
 async def update_ml_app(request: web.Request, appname, body) -> web.Response:
-    """Updated app
+    """
+    Update app.
 
     Update ML application by name.
 

openapi_server/controllers/security_controller_.py

@@ -0,0 +1,8 @@
+"""
+
+Import necessary module from the library typing.
+
+This module provides runtime support for type hints.
+
+
+"""

test-requirements.txt

@@ -2,3 +2,4 @@ pytest~=4.6.7 # needed for python 2.7+3.4
 pytest-cov>=2.8.1
 pytest-randomly==1.2.3 # needed for python 2.7+3.4
 pytest-aiohttp>=0.3.0
+pydocstyle-6.1.1