nicolas
/
gaspype
mirror of https://github.com/DLR-Institute-of-Future-Fuels/gaspype.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docstring fixed for species function

This commit is contained in:
Nicolas Kruse 2025-06-18 00:46:31 +02:00
parent fd94cb2f24
commit 93f6d88cd4
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/gaspype/_main.py
View File

@ -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