From 93f6d88cd4b7b301f439370db3bd9ddd675caa4b Mon Sep 17 00:00:00 2001 From: Nicolas Kruse Date: Wed, 18 Jun 2025 00:46:31 +0200 Subject: [PATCH] docstring fixed for species function --- src/gaspype/_main.py | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/gaspype/_main.py b/src/gaspype/_main.py index 0ba80e8..b69d419 100644 --- a/src/gaspype/_main.py +++ b/src/gaspype/_main.py @@ -21,13 +21,10 @@ def species(pattern: str = '*', element_names: str | list[str] = [], use_regex: filtered by a pattern if supplied Args: - pattern: Optional filter for specific molecules - Placeholder characters: - # A number including non written ones: 'C#H#' matches 'CH4'; - $ Arbitrary element name; - * Any sequence of characters - element_names: - restrict results to species that contain only the specified elements. + pattern: Optional filter for specific molecules. Placeholder + characters: # A number including non written ones: 'C#H#' matches 'CH4'; + $ Arbitrary element name; * Any sequence of characters + element_names: restrict results to species that contain only the specified elements. The elements can be supplied as list of strings or as comma separated string. use_regex: using regular expression for the pattern