-
Notifications
You must be signed in to change notification settings - Fork 576
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
remove warning and add it as doc string (#4240)
- Loading branch information
Showing
1 changed file
with
11 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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"] |