doc: add docstring comment to new function

#810 Co-authored-by: Sascha Fendrich <[email protected]>
GIScience · Aug 29, 2024 · 8b1f177 · 8b1f177
1 parent 04a929a
commit 8b1f177
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/ohsome_quality_api/utils/validators.py b/ohsome_quality_api/utils/validators.py
@@ -21,6 +21,8 @@
 
 
 def validate_attribute_topic_combination(attribute: AttributeEnum, topic: TopicEnum):
+    """As attributes are only meaningful for a certain topic,
+    we need to check if the given combination is valid"""
     valid_attributes_for_topic = get_attributes()[topic]
     all_attributes = [attribute for attribute in valid_attributes_for_topic]