Better comments

tracim/config.py

@@ -87,7 +87,7 @@ class CFG(object):
             '',
         )
 
-        # TODO - G.M - 26-03-2018 - These params seems deprecated for tracimv2,
+        # TODO - G.M - 26-03-2018 - [Cleanup] These params seems deprecated for tracimv2,
         # Verify this
         #
         # self.WEBSITE_HOME_TITLE_COLOR = settings.get(
@@ -138,7 +138,7 @@ class CFG(object):
             '604800',
         ))
 
-        # TODO - G.M - 27-03-2018 - Restore email config
+        # TODO - G.M - 27-03-2018 - [Email] Restore email config
         ###
         # EMAIL related stuff (notification, reply)
         ###
@@ -312,7 +312,7 @@ class CFG(object):
         # WSGIDAV (Webdav server)
         ###
 
-        # TODO - G.M - 27-03-2018 - Restore wsgidav config
+        # TODO - G.M - 27-03-2018 - [WebDav] Restore wsgidav config
         #self.WSGIDAV_CONFIG_PATH = settings.get(
         #    'wsgidav.config_path',
         #    'wsgidav.conf',
@@ -346,7 +346,7 @@ class CFG(object):
         # if not self.WSGIDAV_CLIENT_BASE_URL.endswith('/'):
         #     self.WSGIDAV_CLIENT_BASE_URL += '/'
 
-        # TODO - G.M - 27-03-2018 - Restore radicale config
+        # TODO - G.M - 27-03-2018 - [Caldav] Restore radicale config
         ###
         # RADICALE (Caldav server)
         ###

tracim/fixtures/content.py

@@ -1,4 +1,4 @@
-# TODO : Reenable this when API where availables
+# TODO : [LibContent] Reenable this when API where availables
 # # -*- coding: utf-8 -*-
 # from depot.io.utils import FileIntent
 #

tracim/lib/user.py

@@ -6,7 +6,7 @@ import typing as typing
 
 from tracim.models.auth import User
 
-# TODO - G.M -28-03-2018 - Check if "current user" stuff is always needed for tracimv2
+# TODO - G.M -28-03-2018 - [CurrentUser] Check if "current user" stuff is always needed for tracimv2
 # CURRENT_USER_WEB = 'WEB'
 # CURRENT_USER_WSGIDAV = 'WSGIDAV'
 
@@ -55,7 +55,7 @@ class UserApi(object):
         if email and self._user and user.user_id==self._user.user_id:
             pass
             # this is required for the _session to keep on being up-to-date
-            # TODO - G.M - 28-03-2018 - Check for pyramid equivalent
+            # TODO - G.M - 28-03-2018 - [CurrentUser] Check for pyramid equivalent
             # tg.request.identity['repoze.who.userid'] = email
             # tg.auth_force_login(email)
 
@@ -91,7 +91,7 @@ class UserApi(object):
         :return:
         """
         # NOTE: Cyclic import
-        # TODO - G.M - 28-03-2018 - Reenable Calendar stuff
+        # TODO - G.M - 28-03-2018 - [Calendar] Reenable Calendar stuff
         #from tracim.lib.calendar import CalendarManager
         #from tracim.model.organisational import UserCalendar
 
@@ -101,6 +101,7 @@ class UserApi(object):
         self._session.flush()
         transaction.commit()
 
+        # TODO - G.M - 28-03-2018 - [Calendar] Reenable Calendar stuff
         # calendar_manager = CalendarManager(created_user)
         # calendar_manager.create_then_remove_fake_event(
         #     calendar_class=UserCalendar,
@@ -108,6 +109,7 @@ class UserApi(object):
         # )
 
 
+# TODO - G.M - 28-03-2018 - [CurrentUser] Check for pyramid equivalent
 # class CurrentUserGetterInterface(object):
 #     def get_current_user(self) -> typing.Union[None, User]:
 #         raise NotImplementedError()
@@ -117,7 +119,7 @@ class UserApi(object):
 #     def __init__(self) -> None:
 #         self.api = UserApi(None)
 
-# TODO - G.M - 28-03-2018 - Check for pyramid equivalent
+
 # class WebCurrentUserGetter(BaseCurrentUserGetter):
 #     def get_current_user(self) -> typing.Union[None, User]:
 #         # HACK - D.A. - 2015-09-02
@@ -132,7 +134,7 @@ class UserApi(object):
 #
 #         return None
 
-# TODO - G.M - 28-03-2018 - Reenable Webdav stuff
+# TODO - G.M - 28-03-2018 - [Webdav] Reenable Webdav stuff
 # class WsgidavCurrentUserGetter(BaseCurrentUserGetter):
 #     def get_current_user(self) -> typing.Union[None, User]:
 #         if hasattr(cherrypy.request, 'current_user_email'):

tracim/models/auth.py

@@ -156,7 +156,7 @@ class User(DeclarativeBase):
             profile_id = max(group.group_id for group in self.groups)
         return Profile(profile_id)
 
-    # TODO - G-M - 27-03-2018 - Check about calendar code
+    # TODO - G-M - 27-03-2018 - [Calendar] Check about calendar code
     # @property
     # def calendar_url(self) -> str:
     #     # TODO - 20160531 - Bastien: Cyclic import if import in top of file

tracim/models/data.py

@@ -86,7 +86,7 @@ class Workspace(DeclarativeBase):
 
         return contents
 
-    # TODO - G-M - 27-03-2018 - Check about calendar code
+    # TODO - G-M - 27-03-2018 - [Calendar] Check about calendar code
     # @property
     # def calendar_url(self) -> str:
     #     # TODO - 20160531 - Bastien: Cyclic import if import in top of file
@@ -1365,7 +1365,7 @@ class VirtualEvent(object):
 
         label = content.get_label()
         if content.type==ContentType.Comment:
-            # todo :voir le _('.... si le _ est utile
+            # TODO :  28-03-2018 [i18n] Internationalize this ?
             label = ('<strong>{}</strong> wrote:').format(content.owner.get_display_name())
 
         return VirtualEvent(id=content.content_id,
@@ -1397,7 +1397,6 @@ class VirtualEvent(object):
         self.content = content
         self.ref_object = ref_object
 
-        # todo moi ? print(type)
         assert hasattr(type, 'id')
         assert hasattr(type, 'css')
         assert hasattr(type, 'icon')

tracim/models/meta.py

@@ -7,7 +7,7 @@ from sqlalchemy.schema import MetaData
 NAMING_CONVENTION = {
     "ix": "ix_%(column_0_label)s",
     "uq": "uq_%(table_name)s_%(column_0_name)s",
-    # TODO - G.M - 28-03-2018 - Convert database to allow naming convention
+    # TODO - G.M - 28-03-2018 - [Database] Convert database to allow naming convention
     # for ck contraint.
     # "ck": "ck_%(table_name)s_%(constraint_name)s",
     "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",

tracim/models/mymodel.py

@@ -7,7 +7,7 @@ from sqlalchemy import (
 
 from .meta import DeclarativeBase
 
-
+# TODO - G.M - 28-03-2018 - [Cleanup] Remove this example Model
 class MyModel(DeclarativeBase):
     __tablename__ = 'models'
     id = Column(Integer, primary_key=True)

tracim/scripts/initializedb.py

@@ -37,7 +37,7 @@ def main(argv=sys.argv):
     DeclarativeBase.metadata.create_all(engine)
 
     session_factory = get_session_factory(engine)
-
+    # TODO - G.M - 28-03-2018 - [Cleanup] Remove code related to example
     with transaction.manager:
         dbsession = get_tm_session(session_factory, transaction.manager)
 

tracim/templates/404.jinja2

@@ -1,3 +1,4 @@
+<!-- TODO - G.M - 28-03-2018 - [Cleanup] Replace this example template -->
 {% extends "layout.jinja2" %}
 
 {% block content %}

tracim/templates/layout.jinja2

@@ -1,3 +1,4 @@
+<!-- TODO - G.M - 28-03-2018 - [Cleanup] Remove this example template -->
 <!DOCTYPE html>
 <html lang="{{request.locale_name}}">
   <head>

tracim/templates/mytemplate.jinja2

@@ -1,3 +1,4 @@
+<!-- TODO - G.M - 28-03-2018 - [Cleanup] Remove this example template -->
 {% extends "layout.jinja2" %}
 
 {% block content %}

tracim/tests/models/test_content.py

@@ -27,7 +27,7 @@ class TestContent(StandardTest):
         content1 = self.test_create()
         content1.description = 'FOO'  # Raise ContentRevisionUpdateError because revision can't be updated
 
-    # TODO - G.M - 28-03-2018 - Reenable this test when libContent is available
+    # TODO - G.M - 28-03-2018 - [libContent] Reenable this test when libContent is available
     # def test_query(self):
     #     content1 = self.test_create()
     #     with new_revision(content1):

tracim/tests/models/test_content_revision.py

@@ -36,7 +36,7 @@ class TestContentRevision(BaseTest):
             dict_repr.pop(key_to_remove, None)
         return dict_repr
 
-    # TODO - G.M - 28-03-2018 - Reenable this test
+    # TODO - G.M - 28-03-2018 - [libContent] Reenable this test
     # def test_new_revision(self):
     #     admin = self._session.query(User).filter(User.email == 'admin@admin.admin').one()
     #     workspace = self._create_workspace_and_test(name='workspace_1', user=admin)

tracim/translation.py

@@ -1,4 +1,4 @@
 
-# TODO - G.M - 27-03-2018 - Reconnect true internationalization
+# TODO - G.M - 27-03-2018 - [i18n] Reconnect true internationalization
 def fake_translator(text: str):
     return text