docs changes

Author: jpillai00

src/rbc/core/qc/xcp.py

@@ -148,7 +148,7 @@ def write_xcp_qc(metrics: XCPQCMetrics, out_path: Path) -> Path:
     Args:
         metrics: A populated :class:`XCPQCMetrics` row.
         out_path: Destination file path (parent dirs created if needed).
-            Should have a ``.parquet`` extension.
+            Parquet content will be written to this path.
 
     Returns:
         The output path (same as *out_path*).

src/rbc/workflows/qc.py

@@ -37,7 +37,7 @@ class QCOutputs:
 
     Attributes:
         metrics: All 24 XCP-style QC fields for the run.
-        qc_file: Path to the written single-row TSV.
+        qc_file: Path to the written single-row Parquet.
         passed: Whether the run passes RBC QC thresholds.
     """
 
@@ -157,7 +157,7 @@ def single_session_qc(
             norm=norm,
         )
 
-        # 9. Write QC TSV
+        # 9. Write QC Parquet
         qc_outputs.qc_file[regressor] = write_xcp_qc(
             qc_outputs.metrics[regressor],
             work_dir / f"reg-{regressor}_qc.parquet",

tests/integration/functional/qc/test_xcp.py

@@ -32,7 +32,7 @@ def test_xcp_qc_from_bold(
     motion_corrected_bold: MotionCorrectedBOLD,
     tmp_path: Path,
 ) -> None:
-    """Compute all sub-metrics from real data, generate XCP TSV, and verify."""
+    """Compute all sub-metrics from real data, generate XCP Parquet, and verify."""
     mc = motion_corrected_bold.mc
     bold_data = motion_corrected_bold.bold_data
     mask = motion_corrected_bold.mask
@@ -71,7 +71,7 @@ def test_xcp_qc_from_bold(
     assert metrics.meanFD >= 0
     assert metrics.meanDVInit >= 0
 
-    # Write TSV and verify
+    # Write Parquet and verify
     out_path = tmp_path / "xcp_qc.parquet"
     write_xcp_qc(metrics, out_path)
     assert out_path.exists()

tests/unit/core/qc/test_xcp.py

@@ -220,7 +220,7 @@ def test_returns_named_tuple(self) -> None:
 # write_xcp_qc
 # ===================================================================
 class TestWriteXcpQc:
-    """Tests for writing XCP QC metrics to TSV."""
+    """Tests for writing XCP QC metrics to Parquet."""
 
     def test_writes_file(self, tmp_path: Path) -> None:
         """Output file is created."""
@@ -237,7 +237,7 @@ def test_correct_headers(self, tmp_path: Path) -> None:
         assert df.columns == EXPECTED_COLUMNS
 
     def test_correct_values(self, tmp_path: Path) -> None:
-        """Values in TSV match the input metrics."""
+        """Values in Parquet match the input metrics."""
         m = _sample_xcp_metrics()
         out = tmp_path / "qc.parquet"
         write_xcp_qc(m, out)
@@ -247,7 +247,7 @@ def test_correct_values(self, tmp_path: Path) -> None:
         assert df["meanFD"][0] == m.meanFD
 
     def test_round_trip_polars(self, tmp_path: Path) -> None:
-        """Polars can read back the TSV and recover the values."""
+        """Polars can read back the Parquet and recover the values."""
         m = _sample_xcp_metrics()
         out = tmp_path / "qc.parquet"
         write_xcp_qc(m, out)