From 5b646afa38fc99650dd43538a44e013648241ab2 Mon Sep 17 00:00:00 2001 From: Hatem Helal Date: Fri, 19 Apr 2024 15:39:46 +0100 Subject: [PATCH] adding molecule docstring --- mess/structure.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/mess/structure.py b/mess/structure.py index f4028c6..5fd6a30 100644 --- a/mess/structure.py +++ b/mess/structure.py @@ -41,7 +41,19 @@ def _repr_html_(self): return v._repr_html_() -def molecule(name: str): +def molecule(name: str) -> Structure: + """Builds a few sample molecules + + Args: + name (str): either "h2" or "water". More to be added. + + Raises: + NotImplementedError: _description_ + + Returns: + Structure: the built molecule as a Structure object + """ + name = name.lower() if name == "h2":