Skip to content

Commit 23c84b9

Browse files
committed
Document markdownkv output format in StackQL constructor
Added 'markdownkv' to the list of available output formats in the StackQL class constructor documentation. This format was added in commit 52d089e but was not documented in the constructor parameters.
1 parent f6cbf7d commit 23c84b9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

pystackql/core/stackql.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ class StackQL:
3232
:param backend_file_storage_location: Specifies location for database file, only applicable when `backend_storage_mode` is 'file'
3333
(defaults to `'{cwd}/stackql.db'`, this option is ignored in `server_mode`)
3434
:type backend_file_storage_location: str, optional
35-
:param output: Determines the format of the output, options are 'dict', 'pandas', and 'csv'
36-
(defaults to `'dict'`, `'csv'` is not supported in `server_mode`)
35+
:param output: Determines the format of the output, options are 'dict', 'pandas', 'csv', and 'markdownkv'
36+
(defaults to `'dict'`, `'csv'` is not supported in `server_mode`, 'markdownkv' is optimized for LLM understanding)
3737
:type output: str, optional
3838
:param sep: Seperator for values in CSV output
3939
(defaults to `','`, `output='csv'` only)

0 commit comments

Comments
 (0)