Skip to content

Commit

Permalink
[fileio/odmlparser] Add keyword hints in docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
mpsonntag committed Oct 24, 2020
1 parent ffdd567 commit bf60ef7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions odml/fileio.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ def save(obj, filename, backend="xml", **kwargs):
should be saved.
:param backend: Format in which the odML document is to be saved.
The default format is XML.
:param kwargs: Writer backend keyword arguments. Refer to the documentation
of the available parsers to check which arguments are supported.
:param kwargs: Writer backend keyword arguments e.g. for adding specific
stylesheets for xml documents or specifying an RDF format.
Refer to the documentation of the available parsers to check
which arguments are supported.
"""
writer = ODMLWriter(backend)
if "." not in filename.split(os.pathsep)[-1]:
Expand Down
6 changes: 4 additions & 2 deletions odml/tools/odmlparser.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,10 @@ def to_string(self, odml_document, **kwargs):
JSON, YAML and RDF.
:param odml_document: odml.Document.
:param kwargs: Writer backend keyword arguments. Refer to the documentation
of the available parsers to check which arguments are supported.
:param kwargs: Writer backend keyword arguments e.g. for adding specific
stylesheets for xml documents or specifying an RDF format.
Refer to the documentation of the available parsers to check
which arguments are supported.
:return: string containing the content of the odml.Document in the
specified format.
Expand Down

0 comments on commit bf60ef7

Please sign in to comment.