From 5043c1f040bad91b003433b809e6d40d9edc38fb Mon Sep 17 00:00:00 2001 From: Cunliang Geng Date: Tue, 14 Nov 2023 16:03:17 +0100 Subject: [PATCH] update docstring --- src/nplinker/strain_collection.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/nplinker/strain_collection.py b/src/nplinker/strain_collection.py index 90b32250..cff5a9de 100644 --- a/src/nplinker/strain_collection.py +++ b/src/nplinker/strain_collection.py @@ -110,7 +110,11 @@ def remove(self, strain: Strain): raise ValueError(f"Strain {strain} not found in strain collection.") def filter(self, strain_set: set[Strain]): - """Remove all strains that are not in strain_set from the strain collection.""" + """Remove all strains that are not in strain_set from the strain collection. + + Args: + strain_set(set[Strain]): Set of strains to keep. + """ # note that we need to copy the list of strains, as we are modifying it for strain in self._strains.copy(): if strain not in strain_set: