From 3adeed277079c249f0139689550191539903ede7 Mon Sep 17 00:00:00 2001
From: "i.nueske" <i.nueske@indiscale.com>
Date: Mon, 28 Oct 2024 16:09:10 +0100
Subject: [PATCH] STY: Docstring indentation
---
src/linkahead/common/models.py | 111 +++++++++++++++++----------------
1 file changed, 57 insertions(+), 54 deletions(-)
diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py
index 44734252..781955cb 100644
--- a/src/linkahead/common/models.py
+++ b/src/linkahead/common/models.py
@@ -2542,27 +2542,28 @@ class PropertyList(list):
Params
------
- listobject : Iterable(Property)
- List to be filtered
- prop : Property
- Property to match name and ID with. Cannot be
- set simultaneously with ID or name.
- pid : str, int
- Property ID to match
- name : str
- Property name to match
- check_equality : bool, default: False
- If set to True, potential matches will be checked
- using the equality operator instead of ID and name.
- Will be ignored if the prop parameter is not set.
- check_wrapped : bool, default: True
- If set to False, only the wrapper elements
- contained in the given PropertyList will be
- checked, not the original Properties they wrap.
+ listobject : Iterable(Property)
+ List to be filtered
+ prop : Property
+ Property to match name and ID with. Cannot be
+ set simultaneously with ID or name.
+ pid : str, int
+ Property ID to match
+ name : str
+ Property name to match
+ check_equality : bool, default: False
+ If set to True, potential matches will be checked
+ using the equality operator instead of ID and name.
+ Will be ignored if the prop parameter is not set.
+ check_wrapped : bool, default: True
+ If set to False, only the wrapper elements
+ contained in the given PropertyList will be
+ checked, not the original Properties they wrap.
Returns
-------
- list with all matching Properties
+ matches : list
+ List containing all matching Properties
"""
return _filter_entity_list(self, pid=pid, name=name, entity=prop,
check_equality=check_equality, check_wrapped=check_wrapped)
@@ -2717,27 +2718,28 @@ class ParentList(list):
Params
------
- listobject : Iterable(Parent)
- List to be filtered
- parent : Parent
- Parent to match name and ID with. Cannot be set
- pid : str, int
- Parent ID to match
- name : str
- Parent name to match
- simultaneously with ID or name.
- check_equality : bool, default: False
- If set to True, potential matches will be checked
- using the equality operator instead of ID and name.
- Will be ignored if the entity parameter is not set.
- check_wrapped : bool, default: True
- If set to False, only the wrapper elements
- contained in the given ParentList will be
- checked, not the original Parents they wrap.
+ listobject : Iterable(Parent)
+ List to be filtered
+ parent : Parent
+ Parent to match name and ID with. Cannot be set
+ pid : str, int
+ Parent ID to match
+ name : str
+ Parent name to match
+ simultaneously with ID or name.
+ check_equality : bool, default: False
+ If set to True, potential matches will be checked
+ using the equality operator instead of ID and name.
+ Will be ignored if the entity parameter is not set.
+ check_wrapped : bool, default: True
+ If set to False, only the wrapper elements
+ contained in the given ParentList will be
+ checked, not the original Parents they wrap.
Returns
-------
- list with all matching Parents
+ matches : list
+ List containing all matching Parents
"""
return _filter_entity_list(self, pid=pid, name=name, entity=parent,
check_equality=check_equality, check_wrapped=check_wrapped)
@@ -5527,27 +5529,28 @@ def _filter_entity_list(listobject, entity:Entity = None, pid:Union[str, int] =
Params
------
- listobject : Iterable(Entity)
- List to be filtered
- entity : Entity
- Entity to match name and ID for. Cannot be set
- simultaneously with ID or name.
- pid : str, int
- Entity ID to match
- name : str
- Entity name to match
- check_equality : bool, default: False
- If set to True, potential matches will be checked
- using the equality operator instead of ID and name.
- Will be ignored if the entity parameter is not set.
- check_wrapped : bool, default: True
- If set to False, only the wrapper elements
- contained in the given list will be checked and
- returned, not the original Entities they wrap.
+ listobject : Iterable(Entity)
+ List to be filtered
+ entity : Entity
+ Entity to match name and ID for. Cannot be set
+ simultaneously with ID or name.
+ pid : str, int
+ Entity ID to match
+ name : str
+ Entity name to match
+ check_equality : bool, default: False
+ If set to True, potential matches will be checked
+ using the equality operator instead of ID and name.
+ Will be ignored if the entity parameter is not set.
+ check_wrapped : bool, default: True
+ If set to False, only the wrapper elements
+ contained in the given list will be checked and
+ returned, not the original Entities they wrap.
Returns
-------
- list with all matching Entities
+ matches : list
+ List containing all matching Entities
"""
# Check correct input params and setup
match_entity = False
--
GitLab