miklo
/
pandas_ods_reader
mirror of https://forge.citizen4.eu/miklo/pandas_ods_reader.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve docstring

This commit is contained in:
iuvbio 2021-10-04 14:34:29 +02:00
parent b7113b3011
commit c1d003bec4
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pandas_ods_reader/main.py
View File

@ -14,14 +14,14 @@ def read_ods(file_or_path, sheet=1, headers=True, columns=None):
Parameters Parameters
---------- ----------
file_or_path : str file_or_path : str or pathlib.Path
The path to the .ods or .fods file. The path to the .ods or .fods file.
sheet : int or str, default 1 sheet : int or str, default 1
If `int`, the 1 based index of the sheet to be read. If `str`, the If `int`, the 1 based index of the sheet to be read. If `str`, the
name of the sheet to be read. name of the sheet to be read.
header : bool, default True header : bool, default True
If `True`, then the first row is treated as the list of column names. If `True`, then the first row is treated as the list of column names.
columns : list or None, optional columns : list, default None, optional
A list of column names to be used as headers. A list of column names to be used as headers.
Returns Returns