Update timing documentation to relate to LabVIEW waveforms. (#159)

* Update timing documentation to relate to LabVIEW waveforms.

Signed-off-by: Michael Johansen <[email protected]>

* Address review feedback by updating comments.

Signed-off-by: Michael Johansen <[email protected]>

* Update src/nitypes/waveform/_timing/_timing.py

Co-authored-by: Brad Keryan <[email protected]>

* Change :property: to :attr:

Signed-off-by: Michael Johansen <[email protected]>

---------

Signed-off-by: Michael Johansen <[email protected]>
Co-authored-by: Michael Johansen <[email protected]>
Co-authored-by: Brad Keryan <[email protected]>

Author: 3 people

src/nitypes/waveform/_timing/_timing.py

@@ -203,7 +203,11 @@ def has_start_time(self) -> bool:
 
     @property
     def start_time(self) -> TTimestamp_co:
-        """The time that the first sample in the waveform was acquired."""
+        """The time that the first sample in the waveform was acquired.
+
+        This is equivalent to ``t0`` in a LabVIEW waveform.
+        This value is derived from :attr:`timestamp` + :attr:`time_offset`.
+        """
         value = self.timestamp
         if self.has_time_offset:
             # Work around https://github.com/python/mypy/issues/18203
@@ -230,7 +234,10 @@ def has_sample_interval(self) -> bool:
 
     @property
     def sample_interval(self) -> TSampleInterval_co:
-        """The time interval between samples."""
+        """The time interval between samples.
+
+        This is equivalent to ``dt`` in a LabVIEW waveform.
+        """
         value = self._sample_interval
         if value is None:
             raise RuntimeError("The waveform timing does not have a sample interval.")