🎨 Qualify refs to documented functions.

Author: shnizzedy

CPAC/pipeline/engine/resource.py

@@ -224,7 +224,7 @@ def keys(self) -> list[str]:
         return list(self._keys)
 
     def __contains__(self, item: Any) -> bool:
-        """Return ``True`` if `item` in :py:method:`~Resource.keys()`, ``False`` otherwise."""
+        """Return ``True`` if `item` in :py:meth:`Resource.keys()`, ``False`` otherwise."""
         return item in self.keys()
 
     def __getitem__(self, name: str) -> Any:

CPAC/pipeline/test/test_engine.py

@@ -46,7 +46,7 @@ def _set_up_test(
 def test_ingress_func_raw_data(
     bids_examples: Path, preconfig: str, tmp_path: Path
 ) -> None:
-    """Test :py:method:`ResourcePool.ingress_raw_func_data` ."""
+    """Test :py:meth:`~CPAC.pipeline.engine.resource.ResourcePool.ingress_raw_func_data` ."""
     cfg, sub_data_dct = _set_up_test(bids_examples, preconfig, tmp_path)
     rpool = ResourcePool(cfg=cfg, data_paths=sub_data_dct)
     rpool.gather_pipes(rpool.wf, cfg, all_types=True)
@@ -56,7 +56,7 @@ def test_ingress_func_raw_data(
 def test_ingress_anat_raw_data(
     bids_examples: Path, preconfig: str, tmp_path: Path
 ) -> None:
-    """Test :py:method:`ResourcePool.ingress_raw_anat_data` ."""
+    """Test :py:meth:`~CPAC.pipeline.engine.resource.ResourcePool.ingress_raw_anat_data` ."""
     cfg, sub_data_dct = _set_up_test(bids_examples, preconfig, tmp_path)
     rpool = ResourcePool(
         cfg=cfg,
@@ -70,7 +70,7 @@ def test_ingress_anat_raw_data(
 def test_ingress_pipeconfig_data(
     bids_examples: Path, preconfig: str, tmp_path: Path
 ) -> None:
-    """Test :py:method:`ResourcePool.ingress_pipeconfig_paths` ."""
+    """Test :py:meth:`~CPAC.pipeline.engine.resource.ResourcePool.ingress_pipeconfig_paths` ."""
     cfg, sub_data_dct = _set_up_test(bids_examples, preconfig, tmp_path)
     rpool = ResourcePool(
         cfg=cfg,
@@ -83,7 +83,7 @@ def test_ingress_pipeconfig_data(
 def test_build_anat_preproc_stack(
     bids_examples: Path, preconfig: str, tmp_path: Path
 ) -> None:
-    """Test :py:func:`~build_anat_preproc_stack` ."""
+    """Test :py:func:`~CPAC.pipeline.cpac_pipeline.build_anat_preproc_stack` ."""
     cfg, sub_data_dct = _set_up_test(bids_examples, preconfig, tmp_path)
 
     rpool = ResourcePool(cfg=cfg, data_paths=sub_data_dct)
@@ -94,7 +94,7 @@ def test_build_anat_preproc_stack(
 
 @pytest.mark.parametrize("preconfig", ["default"])
 def test_build_workflow(bids_examples: Path, preconfig: str, tmp_path: Path) -> None:
-    """Test :py:func:`~build_workflow` ."""
+    """Test :py:func:`~CPAC.pipeline.cpac_pipeline.build_workflow` ."""
     cfg, sub_data_dct = _set_up_test(bids_examples, preconfig, tmp_path)
     rpool = ResourcePool(cfg=cfg, data_paths=sub_data_dct)
     wf = build_workflow(sub_data_dct["subject_id"], sub_data_dct, cfg)