Skip to content

Commit d6af10e

Browse files
committed
Corrects documentation to include sub-tracking in the API
1 parent 98933dd commit d6af10e

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

docs/api.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
API
22
===
33

4-
.. automodule:: gpu_tracker
5-
4+
gpu_tracker.tracker
5+
-------------------
66
.. automodule:: gpu_tracker.tracker
77
:members:
88
:undoc-members:
9+
10+
gpu_tracker.sub_tracker
11+
-----------------------
12+
.. automodule:: gpu_tracker.sub_tracker
13+
:members:
14+
:undoc-members:

src/gpu_tracker/sub_tracker.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1+
<<<<<<< Updated upstream
12
"""The ``sub_tracker`` module contains the ``SubTracker`` class which can alternatively be imported directly from the ``gpu_tracker`` package."""
3+
=======
4+
"""The ``sub_tracker`` module contains the ``SubTracker`` class which can alternatively be imported directly from the ``gpu_tracker`` package. Additionally, it contains the ``SubTrackingAnalyzer`` class which generates the ``SubTrackingResults`` from the data produced by the ``SubTracker`` and finally the ``TrackingComparison`` which generates the ``ComparisonResults`` comparing the ``SubTrackingResults`` of multiple tracking sessions."""
5+
from __future__ import annotations
6+
>>>>>>> Stashed changes
27
import inspect
38
import os
49
import time

0 commit comments

Comments
 (0)