From 187090c4c1e72d6b554e89954c4fd64740287666 Mon Sep 17 00:00:00 2001
From: Jean-Paul Smets <jp@nexedi.com>
Date: Wed, 28 Feb 2007 18:03:25 +0000
Subject: [PATCH] Added comments on naming.

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@13112 20353a03-c40f-0410-a6d1-a30d3c3de9de
---
 product/ERP5Form/SelectionTool.py | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/product/ERP5Form/SelectionTool.py b/product/ERP5Form/SelectionTool.py
index 2e7224fc27..a03187b235 100644
--- a/product/ERP5Form/SelectionTool.py
+++ b/product/ERP5Form/SelectionTool.py
@@ -117,10 +117,16 @@ class SelectionTool( UniqueObject, SimpleItem ):
 
       context = REQUEST['PARENTS'][0]
       form_id = dialog_id or REQUEST.get('dialog_id', None) or form_id or REQUEST.get('form_id', 'view')
-      return getattr(context, form_id)()      
+      return getattr(context, form_id)()
 
     security.declareProtected(ERP5Permissions.View, 'getSelectionNames')
     def getSelectionNames(self, context=None, REQUEST=None):
+      """
+        Returns the selection names of the current user.
+
+        NOTE - The naming getSelectionNames is wrong. It
+        should be getSelectionNameList to follow conventions
+      """
       if context is None: context = self
       if not REQUEST:
         REQUEST = get_request()
@@ -596,7 +602,7 @@ class SelectionTool( UniqueObject, SimpleItem ):
     security.declareProtected(ERP5Permissions.View, 'setPage')
     def setPage(self, list_selection_name, listbox_uid, query_string=None, uids=None, REQUEST=None):
       """
-        Set page
+         Sets the current displayed page in a selection
       """
       if uids is None: uids = []
       selection = self.getSelectionFor(list_selection_name, REQUEST)
-- 
2.30.9