Add a docstring for the params class.

SasView · Jan 15, 2025 · 44b9f56 · 44b9f56
1 parent 9011680
commit 44b9f56
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/sasdata/temp_ascii_reader.py b/sasdata/temp_ascii_reader.py
@@ -26,6 +26,9 @@ def initialise_separator_dict() -> dict[str, bool]:
 
 @dataclass
 class AsciiReaderParams:
+    """This object contains the parameters that are used to load a series of
+    ASCII files. These parameters can be generated by the ASCII Reader Dialog
+    when using SasView."""
     filenames: list[str] # These will be the FULL file path. Will need to convert to basenames for some functions.
     columns: list[tuple[str, NamedUnit]]
     metadata: AsciiReaderMetadata = field(default_factory=AsciiReaderMetadata)