#50 hotfix API doc fixes

KCL-BMEIS · Jan 24, 2024 · 1884b4c · 1884b4c
1 parent 252c1bb
commit 1884b4c
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/src/spectrumdevice/__init__.py b/src/spectrumdevice/__init__.py
@@ -7,12 +7,16 @@
 for controlling devices:
 
 ### Hardware Classes
-| Name                       | Purpose                                                 |
-|----------------------------|---------------------------------------------------------|
-| `SpectrumDigitiserCard`    | Controlling individual digitiser cards                  |
-| `SpectrumDigitiserStarHub` | Controlling digitiser cards aggregated with a StarHub   |
-| `SpectrumAWGCard`          | Controlling individual AWG cards                        |
-| `SpectrumAWGStarHub`       | Controlling AWG cards aggregated with a StarHub         |
+| Name                             | Purpose                                                 |
+|----------------------------------|---------------------------------------------------------|
+| `SpectrumDigitiserCard`          | Controlling individual digitiser cards                  |
+| `SpectrumDigitiserStarHub`       | Controlling digitiser cards aggregated with a StarHub   |
+| `SpectrumDigitiserAnalogChannel` | Controlling analog channels of a digitiser              |
+| `SpectrumDigitiserIOLine`        | Controlling multipurpose IO channels of a digitiser     |
+| `SpectrumAWGCard`                | Controlling individual AWG cards                        |
+| `SpectrumAWGStarHub`             | (not yet implemented)                                   |
+| `SpectrumAWGAnalogChannel`       | Controlling analog channels of an AWG                   |
+| `SpectrumAWGIOLine`              | Controlling multipurpose IO channels of an AWG          |
 
 ### Mock Classes
 `spectrumdevice` also includes mock classes for testing software without drivers installed or hardware connected:

diff --git a/src/spectrumdevice/devices/awg/awg_card.py b/src/spectrumdevice/devices/awg/awg_card.py
@@ -30,6 +30,7 @@
 class SpectrumAWGCard(
     AbstractSpectrumCard[SpectrumAWGAnalogChannelInterface, SpectrumAWGIOLineInterface], AbstractSpectrumAWG
 ):
+    """Class for controlling individual Spectrum AWG cards."""
     def _init_analog_channels(self) -> Sequence[SpectrumAWGAnalogChannelInterface]:
         num_modules = self.read_spectrum_device_register(SPC_MIINST_MODULES)
         num_channels_per_module = self.read_spectrum_device_register(SPC_MIINST_CHPERMODULE)

diff --git a/src/spectrumdevice/features/pulse_generator/pulse_generator.py b/src/spectrumdevice/features/pulse_generator/pulse_generator.py
@@ -52,6 +52,7 @@
 
 
 class PulseGenerator(PulseGeneratorInterface):
+    """Class for controlling pulse generators associated with IO lines (requires firmware option be enabled)."""
     def __init__(self, parent: SpectrumIOLineInterface):
         self._parent_io_line = parent
         # last char of IO line name is IO line chanel number, which is used to set pulse generator number