From c5ebbe0b783928f0461ea0b5adce6d413d7ff90a Mon Sep 17 00:00:00 2001 From: Austin Marino <32184751+austinmm@users.noreply.github.com> Date: Sat, 12 Oct 2019 15:56:16 -0700 Subject: [PATCH] Added Comments to formating configurations --- docs/plugins/export.rst | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/plugins/export.rst b/docs/plugins/export.rst index f7f9e0217..ba9ae2808 100644 --- a/docs/plugins/export.rst +++ b/docs/plugins/export.rst @@ -71,11 +71,34 @@ The default options look like this:: sort_keys: True csv: formatting: + /* + Used as the separating character between fields. The default value is a comma (,). + */ delimiter: ',' - dialect: 'excel' + /* + A dialect, in the context of reading and writing CSVs, + is a construct that allows you to create, store, + and re-use various formatting parameters for your data. + */ + dialect: 'excel' xml: formatting: + /* + Use encoding="unicode" to generate a Unicode string (otherwise, a bytestring is generated). + */ encoding: 'unicode', + /* + Controls if an XML declaration should be added to the file. + Use False for never, True for always, None for only if not US-ASCII or UTF-8 or Unicode (default is None). + */ xml_declaration: True, + /* + Can be either "xml", "html" or "text" (default is "xml") + */ method: 'xml' + /* + Controls the formatting of elements that contain no content. + If True (the default), they are emitted as a single self-closed tag, + otherwise they are emitted as a pair of start/end tags. + */ short_empty_elements: True