Skip to content

Commit

Permalink
remove warning and add it as doc string (#4240)
Browse files Browse the repository at this point in the history
  • Loading branch information
Remi-Gau committed Jan 26, 2024
1 parent 6f2f799 commit 48cc9ab
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions nilearn/experimental/__init__.py
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
"""The :mod:`nilearn.experimental` module provides importable modules that \
enable the use of experimental features.
The features and estimators that are experimental aren't subject to
deprecation cycles. Use them at your own risks!
"""
.. warning::
import warnings
All features in the ``nilearn.experimental`` module
are experimental and subject to change.
warnings.warn(
"\n\n\nAll features in the nilearn.experimental module are "
"experimental and subject to change. They are included "
"in the nilearn package to gather early feedback from users "
"about prototypes of new features. "
"Changes may break backwards compatibility without prior "
"notice or a deprecation cycle. Moreover, some features may "
"be incomplete or may have been tested less thoroughly than "
"the rest of the library.\n\n"
)
They are included in the nilearn package
to gather early feedback from users about prototypes of new features.
Changes may break backwards compatibility
without prior notice or a deprecation cycle.
Moreover, some features may be incomplete
or may have been tested less thoroughly than the rest of the library.
Use those features at your own risks!
"""
__all__ = ["surface"]

0 comments on commit 48cc9ab

Please sign in to comment.