From d2766637327f5504a653d67e3a802377492b364e Mon Sep 17 00:00:00 2001 From: Leo Kirchner Date: Thu, 15 Feb 2024 11:22:03 +0100 Subject: [PATCH] fixes wording for a couple of docstrings --- diffsync/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/diffsync/__init__.py b/diffsync/__init__.py index acaf732..e6867cb 100644 --- a/diffsync/__init__.py +++ b/diffsync/__init__.py @@ -425,7 +425,7 @@ def remove_child(self, child: "DiffSyncModel") -> None: class Adapter: # pylint: disable=too-many-public-methods - """Class for storing a group of DiffSyncModel instances and diffing/synchronizing to another DiffSync instance.""" + """Class for storing a group of DiffSyncModel instances and diffing/synchronizing to another Adapter instance.""" # In any subclass, you would add mapping of names to specific model classes here: # modelname1 = MyModelClass1 @@ -835,7 +835,7 @@ def remove(self, obj: DiffSyncModel, remove_children: bool = False) -> None: def get_or_instantiate( self, model: Type[DiffSyncModel], ids: Dict, attrs: Optional[Dict] = None ) -> Tuple[DiffSyncModel, bool]: - """Attempt to get the object with provided identifiers or instantiate it with provided identifiers and attrs. + """Attempt to get the object with provided identifiers or instantiate and add it with provided identifiers and attrs. Args: model: The DiffSyncModel to get or create. @@ -848,7 +848,7 @@ def get_or_instantiate( return self.store.get_or_instantiate(model=model, ids=ids, attrs=attrs) def get_or_add_model_instance(self, obj: DiffSyncModel) -> Tuple[DiffSyncModel, bool]: - """Attempt to get the object with provided obj identifiers or instantiate obj. + """Attempt to get the object with provided obj identifiers or add obj. Args: obj: An obj of the DiffSyncModel to get or add.