Skip to content

Commit 9e0a969

Browse files
committed
Add docstring on Correspondances
1 parent 16cbe9c commit 9e0a969

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

doc/autodoc/tracking.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Correspondances
2+
============
3+
4+
.. automodule:: py_eddy_tracker.tracking
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+

src/py_eddy_tracker/tracking.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# -*- coding: utf-8 -*-
22
"""
3-
===========================================================================
43
This file is part of py-eddy-tracker.
54
65
py-eddy-tracker is free software: you can redistribute it and/or modify
@@ -78,6 +77,10 @@ def __init__(
7877
self, datasets, virtual=0, class_method=None, previous_correspondance=None
7978
):
8079
"""Initiate tracking
80+
81+
:param list(str) datasets: A sorted list of filename which contains eddy observations to track
82+
:param class class_method: A class which tell how to track
83+
:param Correspondances previous_correspondance: A previous correspondance object if you want continue tracking
8184
"""
8285
super().__init__()
8386
# Correspondance dtype

0 commit comments

Comments
 (0)