Skip to content

Commit

Permalink
Remove deprecated fetch_surf_fsaverage5 (nilearn#2447)
Browse files Browse the repository at this point in the history
* Update struct.py

Issue nilearn#2358

* Update CONTRIBUTING.rst to include developer install instructions

As a newcomer I had difficulty figuring how to install the nilearn package so that my code  changes were reflected immediately. This may help others like me. Let me know if you think it's useful and feel free to suggest changes to wording :) .
  • Loading branch information
jnecus authored May 21, 2020
1 parent 4b16c11 commit bfcd2d0
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@ You can check out the latest sources with the command::
or if you have write privileges::

git clone [email protected]:nilearn/nilearn.git
Installing the latest code
---------------------------

In order to ensure that any code changes are reflected in your installation, navigate to your cloned Nilearn base directory and install using the following command::

pip install -e .


Coding guidelines
------------------
Expand Down
7 changes: 3 additions & 4 deletions nilearn/datasets/struct.py
Original file line number Diff line number Diff line change
Expand Up @@ -500,9 +500,8 @@ def _fetch_surf_fsaverage(data_dir=None):


def fetch_surf_fsaverage5(data_dir=None, url=None, resume=True, verbose=1):
""" Deprecated since version 0.4.3
Use fetch_surf_fsaverage instead.
""" NOTE: This function is deprecated and will be removed in
0.7.0 release. Use `fetch_surf_fsaverage` instead.
Parameters
----------
Expand All @@ -529,7 +528,7 @@ def fetch_surf_fsaverage5(data_dir=None, url=None, resume=True, verbose=1):
"""
warnings.warn("fetch_surf_fsaverage5 has been deprecated and will "
"be removed in a future release. "
"be removed in 0.7.0 release. "
"Use fetch_surf_fsaverage(mesh='fsaverage5')",
np.VisibleDeprecationWarning, stacklevel=2)
return fetch_surf_fsaverage(mesh='fsaverage5', data_dir=data_dir)
Expand Down

0 comments on commit bfcd2d0

Please sign in to comment.