[DEP] deprecate bids_langloc fetcher

doc/changes/latest.rst

@@ -53,6 +53,7 @@ Changes
 - :bdg-dark:`Code` Move user facing function ``concat_niimgs`` out of private module ``nilearn._utils.niimg_conversions`` (:gh:`4167` by `Rémi Gau`_).
 - :bdg-danger:`Deprecation` Rename the parameter ``contrast_type`` in :func:`~glm.compute_contrast` and attribute ``contrast_type`` in  :class:`~glm.Contrast` to ``stat_type`` (:gh:`4191` by `Rémi Gau`_).
 - :bdg-danger:`Deprecation` :func:`~plotting.plot_surf_roi` will raise a warning if ``roi_map`` contains negative or non-integer values; in version 0.13 this will be a ``ValueError`` (:gh:`4131` by `Michelle Wang`_).
+- :bdg-danger:`Deprecation` ``nilearn.datasets.fetch_bids_langloc_dataset`` will be deprecated in release 0.13 as it returns data simuilar to :func:`~.datasets.fetch_language_localizer_demo_dataset` (:gh:`4219` by `Rémi Gau`_).
 - :bdg-dark:`Code` Remove leading underscore from non private functions to align with PEP8 (:gh:`4086` by `Rémi Gau`_).
 - :bdg-dark:`Code` Make ``decoding/proximal_operator`` explicitly private to align with PEP8 (:gh:`4153` by `Rémi Gau`_).
 - :bdg-dark:`Code` Make private functions public when used outside of their module ``nilearn.interface`` to align with PEP8 (:gh:`4168` by `Rémi Gau`_).

nilearn/conftest.py

@@ -99,6 +99,7 @@ def suppress_specific_warning():
             "`legacy_format` will default to `False`.*|"
             "In release 0.13, this fetcher will return a dictionary.*|"
             "The default strategy for standardize.*|"
+            "The 'fetch_bids_langloc_dataset' function will be removed.*|"
         )
         warnings.filterwarnings(
             "ignore",

nilearn/datasets/func.py

@@ -2215,6 +2215,15 @@
 def fetch_bids_langloc_dataset(data_dir=None, verbose=1):
     """Download language localizer example :term:`bids<BIDS>` dataset.
 
+    .. deprecated:: 0.11.0
+
+        This fetcher function will be removed as it returns the same data
+        as :func:`nilearn.datasets.fetch_language_localizer_demo_dataset`.
+
+        Please use
+        :func:`nilearn.datasets.fetch_language_localizer_demo_dataset`
+        instead.
+
     Parameters
     ----------
     %(data_dir)s
@@ -2227,11 +2236,17 @@
 
     downloaded_files : :obj:`list` of :obj:`str`
         Absolute paths of downloaded files on disk.
-
-    description: :obj:`str`
-        data description
-
     """
+    warnings.warn(
+        (
+            "The 'fetch_bids_langloc_dataset' function will be removed "
+            "in version 0.13.0 as it returns the same data "
+            "as 'fetch_language_localizer_demo_dataset'.\n"
+            "Please use 'fetch_language_localizer_demo_dataset' instead.'"
+        ),
+        DeprecationWarning,
+        stacklevel=2,
+    )
     url = "https://files.osf.io/v1/resources/9q7dv/providers/osfstorage/5888d9a76c613b01fc6acc4e"  # noqa: E501
     dataset_name = "bids_langloc_example"
     main_folder = "bids_langloc_dataset"
@@ -3013,9 +3028,9 @@
         return data
 
     # No. Download the data
     data = _download_data_spm_multimodal(data_dir, subject_dir, subject_id)
     data.description = description
     return data
 
 
 @fill_doc
@@ -3085,7 +3100,7 @@
     # maybe data_dir already contains the data ?
     data = _glob_fiac_data()
     if data is not None:
         data.description = description
         return data
 
     # No. Download the data
@@ -3098,9 +3113,9 @@
         uncompress_file(archive_path)
     except Exception:
         print("Archive corrupted, trying to download it again.")
         data = fetch_fiac_first_level(data_dir=data_dir)
         data.description = description
         return data
 
     data = _glob_fiac_data()
     data.description = description