From: Ben Pfaff <blp@cs.stanford.edu>
Date: Wed, 16 Jul 2025 14:42:10 +0000 (-0700)
Subject: cleanup
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fheads%2Frust;p=pspp

cleanup
---

diff --git a/rust/pspp/src/sys/cooked.rs b/rust/pspp/src/sys/cooked.rs
index 78ad5e4758..9c5b7e0ab5 100644
--- a/rust/pspp/src/sys/cooked.rs
+++ b/rust/pspp/src/sys/cooked.rs
@@ -494,8 +494,8 @@ pub struct ReaderOptions {
 }
 
 impl ReaderOptions {
-    /// Construct a new `ReaderOptions` without specifying an encoding or
-    /// password.
+    /// Construct a new `ReaderOptions` that initially does not specify an
+    /// encoding or password.
     pub fn new() -> Self {
         Self::default()
     }
diff --git a/rust/pspp/src/sys/raw.rs b/rust/pspp/src/sys/raw.rs
index 997bea3ca9..41ab01f42f 100644
--- a/rust/pspp/src/sys/raw.rs
+++ b/rust/pspp/src/sys/raw.rs
@@ -496,87 +496,149 @@ impl From<IoError> for WarningDetails {
 }
 
 /// A raw record in a system file.
-#[allow(missing_docs)] // Don't warn for missing docs on tuple members.
 #[derive(Clone, Debug)]
 pub enum Record {
     /// Variable record.
     ///
     /// Each numeric variable has one variable record.  Each string variable has
     /// one variable record per 8-byte segment.
-    Variable(VariableRecord<RawString>),
+    Variable(
+        /// The record.
+        VariableRecord<RawString>,
+    ),
 
     /// Value labels for numeric and short string variables.
     ///
     /// These appear after the variable records.
-    ValueLabel(ValueLabelRecord<RawDatum, RawString>),
+    ValueLabel(
+        /// The record.
+        ValueLabelRecord<RawDatum, RawString>,
+    ),
 
     /// Document record.
-    Document(DocumentRecord<RawDocumentLine>),
+    Document(
+        /// The record.
+        DocumentRecord<RawDocumentLine>,
+    ),
 
     /// Integer info record.
-    IntegerInfo(IntegerInfoRecord),
+    IntegerInfo(
+        /// The record.
+        IntegerInfoRecord,
+    ),
 
     /// Floating-point info record.
-    FloatInfo(FloatInfoRecord),
+    FloatInfo(
+        /// The record.
+        FloatInfoRecord,
+    ),
 
     /// Variable display record.
-    VarDisplay(VarDisplayRecord),
+    VarDisplay(
+        /// The record.
+        VarDisplayRecord,
+    ),
 
     /// Multiple response variable record.
-    MultipleResponse(MultipleResponseRecord<RawString, RawString>),
+    MultipleResponse(
+        /// The record.
+        MultipleResponseRecord<RawString, RawString>,
+    ),
 
     /// Value labels for long string variables.
-    LongStringValueLabels(LongStringValueLabelRecord<RawString, RawString>),
+    LongStringValueLabels(
+        /// The record.
+        LongStringValueLabelRecord<RawString, RawString>,
+    ),
 
     /// Missing values for long string variables.
     ///
     /// Missing values for numeric and short string variables appear in the
     /// variable records.
-    LongStringMissingValues(LongStringMissingValueRecord<RawString>),
+    LongStringMissingValues(
+        /// The record.
+        LongStringMissingValueRecord<RawString>,
+    ),
 
     /// Encoding record.
     ///
     /// All the strings in the file are encoded in this encoding, even for
     /// strings that precede this record.
-    Encoding(EncodingRecord),
+    Encoding(
+        /// The record.
+        EncodingRecord,
+    ),
 
     /// Extended number of cases.
     ///
     /// The header record records the number of cases but it only uses a 32-bit
     /// field.
-    NumberOfCases(NumberOfCasesRecord),
+    NumberOfCases(
+        /// The record.
+        NumberOfCasesRecord,
+    ),
 
     /// Variable sets.
-    VariableSets(RawVariableSetRecord),
+    VariableSets(
+        /// The record.
+        RawVariableSetRecord,
+    ),
 
     /// Product info.
     ///
     /// This supplements the product in the header record.
-    ProductInfo(RawProductInfoRecord),
+    ProductInfo(
+        /// The record.
+        RawProductInfoRecord,
+    ),
 
     /// Long variable names.
-    LongNames(RawLongNamesRecord),
+    LongNames(
+        /// The record.
+        RawLongNamesRecord,
+    ),
 
     /// Very long string variables, for strings longer than 255 bytes.
-    VeryLongStrings(RawVeryLongStringsRecord),
+    VeryLongStrings(
+        /// The record.
+        RawVeryLongStringsRecord,
+    ),
 
     /// File attributes.
-    FileAttributes(RawFileAttributesRecord),
+    FileAttributes(
+        /// The record.
+        RawFileAttributesRecord,
+    ),
 
     /// Variable attributes.
-    VariableAttributes(RawVariableAttributesRecord),
+    VariableAttributes(
+        /// The record.
+        RawVariableAttributesRecord,
+    ),
 
     /// Extension records not otherwise supported.
-    OtherExtension(Extension),
+    OtherExtension(
+        /// The record.
+        Extension,
+    ),
 
     /// End of headers.
-    EndOfHeaders(u32),
+    EndOfHeaders(
+        /// The record.
+        u32,
+    ),
 
     /// Header record for ZLIB-compressed data.
-    ZHeader(ZHeader),
+    ZHeader(
+        /// The record.
+        ZHeader,
+    ),
 
     /// Trailer record for ZLIB-compressed data.
-    ZTrailer(ZTrailer),
+    ZTrailer(
+        /// The record.
+        ZTrailer,
+    ),
 }
 
 /// A [Record] that has been decoded to a more usable form.