From 4d73de398f7dcc8449ee88427ebfd5b00c642e93 Mon Sep 17 00:00:00 2001 From: "Hedden, Kyle Matthew" Date: Tue, 22 Oct 2024 14:43:36 -0400 Subject: [PATCH] Digital PCT265 story MVAPCT-272: Clean up comments. --- MVMCoreUI/Atomic/Protocols/MoleculeListProtocol.swift | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/MVMCoreUI/Atomic/Protocols/MoleculeListProtocol.swift b/MVMCoreUI/Atomic/Protocols/MoleculeListProtocol.swift index c5d21da6..3b1fad64 100644 --- a/MVMCoreUI/Atomic/Protocols/MoleculeListProtocol.swift +++ b/MVMCoreUI/Atomic/Protocols/MoleculeListProtocol.swift @@ -17,19 +17,19 @@ public protocol MoleculeListProtocol { /// Asks the delegate to add molecules in relation to another molecule. This is the preferred method for relativity. func addMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol], position: AddMoleculesPosition, molecule: (ListItemModelProtocol & MoleculeModelProtocol), animation: UITableView.RowAnimation?) - /** Asks the delegate to remove molecules. Never ask to remove a molecule at an index. + /** Asks the delegate to remove any molecule at a particular index. Never ask to remove a specific molecule via it's index. - Note: Avoid doing this to prevent accidental deletion mid transition. Prefer the declarative approach of deleting a paricular molecule with removeMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol]. + Note: Avoid doing this when possible to prevent accidental deletion mid transition. Prefer the declarative approach of deleting a paricular molecule with removeMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol]. */ func removeMolecules(at indexPaths: [IndexPath], animation: UITableView.RowAnimation?) - /// Asks the delegate to remove particular molecules from the list. + /// Asks the delegate to remove the specified molecules from the list. func removeMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol], animation: UITableView.RowAnimation?) - /// Asks the delegate to swap batches of molecules. + /// Asks the delegate to swap batches of molecules in relation to a particular index. func swapMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol], with replacements: [ListItemModelProtocol & MoleculeModelProtocol], at indexPath: IndexPath, animation: UITableView.RowAnimation?) - /// Asks the delegate to swap batches of molecules. + /// Asks the delegate to swap batches of molecules in relation to a particular molecule. func swapMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol], with replacements: [ListItemModelProtocol & MoleculeModelProtocol], position: AddMoleculesPosition, molecule: (ListItemModelProtocol & MoleculeModelProtocol)?, animation: UITableView.RowAnimation?) }