Skip to content

Commit f4ba6c0

Browse files
committed
add docstring to write_file
1 parent 18f199f commit f4ba6c0

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

.github/ISSUE_TEMPLATE/need_documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Documentation improvement
33
about: Create a report to help us improve the documentation
4-
labels: Documentation
4+
labels: documentation
55
# This template is based on the matplotlib template
66
---
77

src/py_eddy_tracker/observations/observation.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1293,7 +1293,12 @@ def create_variable_zarr(
12931293
def write_file(
12941294
self, path="./", filename="%(path)s/%(sign_type)s.nc", zarr_flag=False
12951295
):
1296-
"""Write a netcdf with eddy obs
1296+
"""Write a netcdf or zarr with eddy obs.
1297+
Zarr is usefull for large dataset > 10M observations
1298+
1299+
:param str path: set path variable
1300+
:param str filename: model to store file
1301+
:param bool zarr_flag: If True, method will use zarr format instead of netcdf
12971302
"""
12981303
filename = filename % dict(
12991304
path=path,

0 commit comments

Comments
 (0)