From d6af10ed8fbef7ce287ce138bad9778219a1bd9d Mon Sep 17 00:00:00 2001 From: erikhuck Date: Tue, 20 May 2025 15:24:45 -0400 Subject: [PATCH] Corrects documentation to include sub-tracking in the API --- docs/api.rst | 10 ++++++++-- src/gpu_tracker/sub_tracker.py | 5 +++++ 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 65c90f0..4d50585 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,8 +1,14 @@ API === -.. automodule:: gpu_tracker - +gpu_tracker.tracker +------------------- .. automodule:: gpu_tracker.tracker :members: :undoc-members: + +gpu_tracker.sub_tracker +----------------------- +.. automodule:: gpu_tracker.sub_tracker + :members: + :undoc-members: diff --git a/src/gpu_tracker/sub_tracker.py b/src/gpu_tracker/sub_tracker.py index 484e2b4..54d910d 100644 --- a/src/gpu_tracker/sub_tracker.py +++ b/src/gpu_tracker/sub_tracker.py @@ -1,4 +1,9 @@ +<<<<<<< Updated upstream """The ``sub_tracker`` module contains the ``SubTracker`` class which can alternatively be imported directly from the ``gpu_tracker`` package.""" +======= +"""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.""" +from __future__ import annotations +>>>>>>> Stashed changes import inspect import os import time