Skip to content

Commit bf60ef7

Browse files
committed
[fileio/odmlparser] Add keyword hints in docstring
1 parent ffdd567 commit bf60ef7

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

odml/fileio.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ def save(obj, filename, backend="xml", **kwargs):
3333
should be saved.
3434
:param backend: Format in which the odML document is to be saved.
3535
The default format is XML.
36-
:param kwargs: Writer backend keyword arguments. Refer to the documentation
37-
of the available parsers to check which arguments are supported.
36+
:param kwargs: Writer backend keyword arguments e.g. for adding specific
37+
stylesheets for xml documents or specifying an RDF format.
38+
Refer to the documentation of the available parsers to check
39+
which arguments are supported.
3840
"""
3941
writer = ODMLWriter(backend)
4042
if "." not in filename.split(os.pathsep)[-1]:

odml/tools/odmlparser.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,10 @@ def to_string(self, odml_document, **kwargs):
9898
JSON, YAML and RDF.
9999
100100
:param odml_document: odml.Document.
101-
:param kwargs: Writer backend keyword arguments. Refer to the documentation
102-
of the available parsers to check which arguments are supported.
101+
:param kwargs: Writer backend keyword arguments e.g. for adding specific
102+
stylesheets for xml documents or specifying an RDF format.
103+
Refer to the documentation of the available parsers to check
104+
which arguments are supported.
103105
104106
:return: string containing the content of the odml.Document in the
105107
specified format.

0 commit comments

Comments
 (0)