diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 261737157..e6fbf038b 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -4307,12 +4307,14 @@ xlsxreader Utility functions to facilitate reading .xlsx spreadsheets. It provides the following low-level API methods: -- ``open_xlsx_file(filename)`` returns an open file_handle -- ``close_xlsx_file(file_handle)`` +- ``open_xlsx_file(filename)`` returns a file_handle or nil on error +- ``close_xlsx_file(file_handle)`` closes the specified file_handle - ``list_sheets(file_handle)`` returns a list of strings representing sheet names -- ``open_sheet(file_handle, sheet_name)`` returns a sheet_handle -- ``close_sheet(sheet_handle)`` +- ``open_sheet(file_handle, sheet_name)`` returns a sheet_handle. This call + always succeeds, even if the sheet doesn't exist. Non-existent sheets will + have no data, though. +- ``close_sheet(sheet_handle)`` closes the specified sheet_handle - ``get_row(sheet_handle, max_tokens)`` returns a list of strings representing the contents of the cells in the next row. The ``max_tokens`` parameter is optional. If set to a number > 0, it limits the number of cells read and