From b068bd1e2ae2c5148b167f4fdcca05a22046b735 Mon Sep 17 00:00:00 2001 From: bronsen Date: Sat, 14 Feb 2026 18:49:24 +0100 Subject: [PATCH] models: add docstring to constructor function --- src/teilchensammler_cli/models.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/teilchensammler_cli/models.py b/src/teilchensammler_cli/models.py index 2052e41..7a49d5c 100644 --- a/src/teilchensammler_cli/models.py +++ b/src/teilchensammler_cli/models.py @@ -25,6 +25,15 @@ class Teilchen(TeilchenCreate, table=True): async def make_teilchen_input(text: str) -> TeilchenCreate | None: + """Constructor to create new Teilchen from user input. + + Args: + text: The whole input string as provided by the user. + + Returns: + Returns new Teilchen instance if enough parts could be extracted. + Returns `None` otherwise. + """ import re from natsort import natsorted