Skip to content
Snippets Groups Projects
Verified Commit d4183d54 authored by Daniel Hornung's avatar Daniel Hornung
Browse files

DOC: Better docstrings.

parent d2f22ac3
No related branches found
No related tags found
2 merge requests!89ENH: JsonSchemaExporter accepts do_not_create parameter.,!83ENH: JsonSchemaExporter can merge schemata and arrayize them
Pipeline #43188 canceled
......@@ -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
----------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment