Better doc + TODO comments

tracim/models/applications.py

 )
 
 pagemarkdownplus = Application(
-    label='Rich Markdown Files',  # TODO : Better label
+    label='Rich Markdown Files',  # TODO - G.M - 24-05-2018 - Check label
     slug='contents/pagemarkdownplus',
     icon='file-code',
     hexcolor='#f12d2d',
 )
 
 pagehtml = Application(
-    label='Text Documents',  # TODO : Better label
+    label='Text Documents',  # TODO - G.M - 24-05-2018 - Check label
     slug='contents/pagehtml',
     icon='file-text-o',
     hexcolor='#3f52e3',

tracim/tests/functional/test_system.py

 # coding=utf-8
+"""
+Tests for /api/v2/system subpath endpoints.
+"""
 from tracim.tests import FunctionalTest
 
 
 class TestApplicationsEndpoint(FunctionalTest):
+    """
+    Tests for /api/v2/system/applications
+    """
+
     def test_api__get_applications__ok_200__nominal_case(self):
+        """
+        Get applications list with a registered user.
+        """
         self.testapp.authorization = (
             'Basic',
             (
         assert 'config' in application
 
     def test_api__get_workspace__err_401__unregistered_user(self):
+        """
+        Get applications list with an unregistered user (bad auth)
+        """
         self.testapp.authorization = (
             'Basic',
             (

tracim/tests/functional/test_user.py

-# coding=utf-8
+# -*- coding: utf-8 -*-
+"""
+Tests for /api/v2/users subpath endpoints.
+"""
 from tracim.tests import FunctionalTest
 from tracim.fixtures.content import Content as ContentFixtures
 from tracim.fixtures.users_and_groups import Base as BaseFixture
 
 
 class TestUserWorkspaceEndpoint(FunctionalTest):
-
+    # -*- coding: utf-8 -*-
+    """
+    Tests for /api/v2/users/{user_id}/workspaces
+    """
     fixtures = [BaseFixture, ContentFixtures]
 
     def test_api__get_user_workspaces__ok_200__nominal_case(self):
+        """
+        Check obtain all workspaces reachables for user with user auth.
+        """
         self.testapp.authorization = (
             'Basic',
             (
         workspace = res[0]
         assert workspace['id'] == 1
         assert workspace['label'] == 'w1'
-        assert len(workspace['sidebar_entries']) == 7  # TODO change this
+        assert len(workspace['sidebar_entries']) == 7
 
         sidebar_entry = workspace['sidebar_entries'][0]
         assert sidebar_entry['slug'] == 'dashboard'
         assert sidebar_entry['icon'] == "calendar-alt"
 
     def test_api__get_user_workspaces__err_403__unallowed_user(self):
+        """
+        Check obtain all workspaces reachables for one user
+        with another non-admin user auth.
+        """
         self.testapp.authorization = (
             'Basic',
             (
         assert 'details' in res.json.keys()
 
     def test_api__get_user_workspaces__err_401__unregistered_user(self):
+        """
+        Check obtain all workspaces reachables for one user
+        without correct user auth (user unregistered).
+        """
         self.testapp.authorization = (
             'Basic',
             (
         assert 'details' in res.json.keys()
 
     def test_api__get_user_workspaces__err_404__user_does_not_exist(self):
+        """
+        Check obtain all workspaces reachables for one user who does
+        not exist
+        with a correct user auth.
+        """
         self.testapp.authorization = (
             'Basic',
             (

tracim/tests/functional/test_workspaces.py

-# coding=utf-8
-from tracim.models.data import UserRoleInWorkspace
+# -*- coding: utf-8 -*-
+"""
+Tests for /api/v2/workspaces subpath endpoints.
+"""
 from tracim.tests import FunctionalTest
 from tracim.fixtures.content import Content as ContentFixtures
 from tracim.fixtures.users_and_groups import Base as BaseFixture
 
 
 class TestWorkspaceEndpoint(FunctionalTest):
+    """
+    Tests for /api/v2/workspaces/{workspace_id} endpoint
+    """
 
     fixtures = [BaseFixture, ContentFixtures]
 
-    def test_api__get_workspace__ok_200__nominal_case(self):
+    def test_api__get_workspace__ok_200__nominal_case(self) -> None:
+        """
+        Check obtain workspace reachable for user.
+        """
         self.testapp.authorization = (
             'Basic',
             (
         assert workspace['slug'] == 'w1'
         assert workspace['label'] == 'w1'
         assert workspace['description'] == 'This is a workspace'
-        assert len(workspace['sidebar_entries']) == 7  # TODO change this
+        assert len(workspace['sidebar_entries']) == 7
 
         sidebar_entry = workspace['sidebar_entries'][0]
         assert sidebar_entry['slug'] == 'dashboard'
         assert sidebar_entry['hexcolor'] == "#757575"
         assert sidebar_entry['icon'] == "calendar-alt"
 
-    def test_api__get_workspace__err_403__unallowed_user(self):
+    def test_api__get_workspace__err_403__unallowed_user(self) -> None:
+        """
+        Check obtain workspace unreachable for user
+        """
         self.testapp.authorization = (
             'Basic',
             (
         assert 'message' in res.json.keys()
         assert 'details' in res.json.keys()
 
-    def test_api__get_workspace__err_401__unregistered_user(self):
+    def test_api__get_workspace__err_401__unregistered_user(self) -> None:
+        """
+        Check obtain workspace without registered user.
+        """
         self.testapp.authorization = (
             'Basic',
             (
         assert 'message' in res.json.keys()
         assert 'details' in res.json.keys()
 
-    def test_api__get_workspace__err_403__workspace_does_not_exist(self):
+    def test_api__get_workspace__err_403__workspace_does_not_exist(self) -> None:  # nopep8
+        """
+        Check obtain workspace who does not exist with an existing user.
+        """
         self.testapp.authorization = (
             'Basic',
             (
 
 
 class TestWorkspaceMembersEndpoint(FunctionalTest):
+    """
+    Tests for /api/v2/workspaces/{workspace_id}/members endpoint
+    """
 
     fixtures = [BaseFixture, ContentFixtures]
 
     def test_api__get_workspace_members__ok_200__nominal_case(self):
+        """
+        Check obtain workspace members list with a reachable workspace for user
+        """
         self.testapp.authorization = (
             'Basic',
             (
                 'admin@admin.admin'
             )
         )
-        res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body
+        res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
         user_role = res[0]
         assert user_role['slug'] == 'workspace_manager'
         assert user_role['user_id'] == 1
         assert user_role['workspace_id'] == 1
         assert user_role['user']['display_name'] == 'Global manager'
-        assert user_role['user']['avatar_url'] is None  # TODO
+        # TODO - G.M - 24-05-2018 - [Avatar] Replace
+        # by correct value when avatar feature will be enabled
+        assert user_role['user']['avatar_url'] is None
 
     def test_api__get_workspace_members__err_403__unallowed_user(self):
+        """
+        Check obtain workspace members list with an unreachable workspace for
+        user
+        """
         self.testapp.authorization = (
             'Basic',
             (
         assert 'details' in res.json.keys()
 
     def test_api__get_workspace_members__err_401__unregistered_user(self):
+        """
+        Check obtain workspace members list with an unregistered user
+        """
         self.testapp.authorization = (
             'Basic',
             (
         assert 'message' in res.json.keys()
         assert 'details' in res.json.keys()
 
-    def test_api__get_workspace_members__err_403__workspace_does_not_exist(self):
+    def test_api__get_workspace_members__err_403__workspace_does_not_exist(self):  # nopep8
+        """
+        Check obtain workspace members list with an existing user but
+        an unexisting workspace
+        """
         self.testapp.authorization = (
             'Basic',
             (

tracim/views/core_api/schemas.py

 
 class ApplicationConfigSchema(marshmallow.Schema):
     pass
-    #  TODO
+    #  TODO - G.M - 24-05-2018 - Set this
 
 
 class ApplicationSchema(marshmallow.Schema):