Cleaned out comments

django-cms · czpython · Jul 2, 2018 · Jun 15, 2018 · Jun 18, 2018 · Jun 18, 2018
commit d92ba32b9dd2da1a92e09604836d9360faf9ec7f
diff --git a/cms/tests/test_log_operations.py b/cms/tests/test_log_operations.py
@@ -60,7 +60,7 @@ def test_log_for_create_admin_page(self):
 
     def test_log_for_create_wizard_page(self):
         """
-        Test that when a page is created via the create page wizard UI a log entry is created.
+        Test that when a page is created via the create page wizard a log entry is created.
         """
 
         superuser = self.get_superuser()

diff --git a/cms/utils/log_operations.py b/cms/utils/log_operations.py
@@ -5,31 +5,13 @@
 from django.utils.translation import ugettext_lazy as _
 
 
-"""
-Logs are all collected here to keep the messages and contents consistent across all operations.
-May seem repetitive but allows each log to be unique for different circumstances.
-Method names make the log being created clear and concise
-
-Issues with current solution:
-    - A log entry isn't created when a page is created using the new page wizard. Again showing a flaw with testing via the API and not the actual fn's!!
-    - Difficult to find the log page creation in the current solution!! The existing implementation,uses the LogEntry model directly, others use the ModelAdmin Implementation. There should be one way where possible!!
-
-Design Considerations:
-    - Allow plugins to integrate with the CMS logger??
-    - A log helper method "create_log" that uses LogEntry and allows the removal of LogEntry at a later date.
-    - A page move event is recorded as CHANGE with no message. A "Moved." message has been manually added
-    - Django admin keeps all logs in one area rather than spreading them out and potentially having them set inconsistently and scattered in multiple files.
-"""
-
-
 """
 Log helper
 """
 
 
 def create_log(user_id, content_type_id, object_id, object_repr, action_flag, change_message):
     """
-    Helper method
     Although this function is repetitive it allows external plugins to access the same logging mechanisms as the cms
     It also removes the dependency of the admin LogEntry in any other Django CMS code
     """
@@ -97,6 +79,7 @@ def log_page_move(request, page_object, message=""):
     Log that a page object has been successfully moved.
     """
 
+    # FIXME: REMOVEME: @Paulo this is set due to the fact that a page move is a CHANGE but no fields are changed so Django sets it as an empty message by default
     if message == "":
         message = _("Moved.")