diff --git a/src/caosadvancedtools/models/parser.py b/src/caosadvancedtools/models/parser.py index 25b5727c2674e0fbfa58f31a595da91aebfc806a..ba63c5cd77217352144e4ec26e052cc2772339ce 100644 --- a/src/caosadvancedtools/models/parser.py +++ b/src/caosadvancedtools/models/parser.py @@ -141,7 +141,11 @@ class JsonSchemaDefinitionError(RuntimeError): def parse_model_from_yaml(filename, existing_model: Optional[dict] = None): - """Shortcut if the Parser object is not needed. + """Parse a data model from a YAML file. + +This is a convenience function if the Parser object is not needed, it calls +``Parser.parse_model_from_yaml(...)`` internally. + Parameters ---------- @@ -155,7 +159,10 @@ existing_model : dict, optional def parse_model_from_string(string, existing_model: Optional[dict] = None): - """Shortcut if the Parser object is not needed. + """Parse a data model from a YAML string + +This is a convenience function if the Parser object is not needed, it calls +``Parser.parse_model_from_string(...)`` internally. Parameters ----------