Added comments to describe the workflow

Author: Ramya Virajamangala

pages/project.py

@@ -597,9 +597,10 @@ def select_from_dropdown_listbox(self, selection):
     resource_information_save_button = Locator(
         By.CSS_SELECTOR, '[data-test-save-resource-metadata-button]'
     )
-
+    # Get the rows of search results matching the locator
     rows = GroupLocator(By.CSS_SELECTOR, '[data-test-user-card-main]')
 
+    # Select the correct user from the table of search results
     def select_from_table_of_rows(self, selection):
         for row in self.rows:
             cell = row.find_element(
@@ -615,11 +616,11 @@ def select_from_table_of_rows(self, selection):
         By.CSS_SELECTOR, '[data-analytics-name="Contributor name"]'
     )
 
+    # Select new_user from contributors list on metadata page
     def select_from_list(self, selection):
         for contributor in self.contributors_list:
             if selection in contributor.text.strip():
                 return contributor
-                break
 
     search_cancel_button = Locator(
         By.CSS_SELECTOR, '[data-test-user-search-cancel-button]'

tests/test_metadata.py

@@ -352,7 +352,7 @@ def test_edit_contributors(
         project_metadata_page.search_input.send_keys(new_user)
         project_metadata_page.contributor_search_button.click()
 
-        # Get the row number for the user from the search table
+        # Select the new_user from the search results and add the user to the project
         WebDriverWait(driver, 5).until(
             EC.visibility_of_element_located(
                 (
@@ -371,6 +371,7 @@ def test_edit_contributors(
                 (By.CSS_SELECTOR, '[data-test-contributors-list]')
             )
         )
+        # Retrieve the new_user from contributors list
         user = project_metadata_page.select_from_list(new_user)
         assert new_user in user.text.strip()