Fine to Lists Should Be Equal documentation related to #2703.

pekkaklarck · pekkaklarck · commit 7131af358fd0 · 2020-02-28T12:28:25.000+02:00
Also tab to spaces in a test.
diff --git a/atest/testdata/standard_libraries/collections/list.robot b/atest/testdata/standard_libraries/collections/list.robot
@@ -331,11 +331,11 @@ Lists Should Be Equal With Named Indices As Dictionary With Too Few Values
     ${names} =    Create Dictionary    0=a    2=c
     Lists Should Be Equal    ${L3}    ${L3B}    names=${names}
 
-Lists Should Be Equal Ignore Order    
+Lists Should Be Equal Ignore Order
     ${list1} =    Create List    A    B    C    D
-    ${list2} =    Create List    D    B    C	A
+    ${list2} =    Create List    D    B    C    A
     Lists Should Be Equal    ${list1}    ${list2}    ignore_order=True
-    
+
 List Should Contain Sub List
     List Should Contain Sub List    ${LONG}    ${L4}
 
diff --git a/src/robot/libraries/Collections.py b/src/robot/libraries/Collections.py
@@ -364,16 +364,12 @@ def lists_should_be_equal(self, list1, list2, msg=None, values=True,
         - If ``msg`` is given and ``values``  is not given a true value,
           the error message is just the given ``msg``.
 
-        Optional ``names`` argument can be used for naming the indices shown in
-        the default error message. It can either be a list of names matching
-        the indices in the lists or a dictionary where keys are indices that
-        need to be named. It is not necessary to name all of the indices.  When
-        using a dictionary, keys can be either integers or strings that can be
-        converted to integers.
-        
-        Optional ``ignore_order`` argument can be used to ignore the order of the
-        elements (element index) in the list while comparing two lists. If set to 
-        true, element order will be ignored.  This option is new in RF 3.2 now.
+        The optional ``names`` argument can be used for naming the indices
+        shown in the default error message. It can either be a list of names
+        matching the indices in the lists or a dictionary where keys are
+        indices that need to be named. It is not necessary to name all of
+        the indices.  When using a dictionary, keys can be either integers
+        or strings that can be converted to integers.
 
         Examples:
         | ${names} = | Create List | First Name | Family Name | Email |
@@ -384,13 +380,15 @@ def lists_should_be_equal(self, list1, list2, msg=None, values=True,
         If the items in index 2 would differ in the above examples, the error
         message would contain a row like ``Index 2 (email): name@foo.com !=
         name@bar.com``.
-        
+
+        The optional ``ignore_order`` argument can be used to ignore the order
+        of the elements in the lists. Using it requires items to be sortable.
+        This is new in Robot Framework 3.2.
+
+        Example:
         | ${list1} = | Create List | apple | cherry | banana |
         | ${list2} = | Create List | cherry | banana | apple |
         | Lists Should Be Equal | ${list1} | ${list2} | ignore_order=True |
-        
-        list index would be ignored while comparing two lists. Above two list 
-        will be matched. 
         """
         self._validate_lists(list1, list2)
         len1 = len(list1)
