summaryrefslogtreecommitdiff
path: root/numpy/lib/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpy/lib/__init__.py')
-rw-r--r--numpy/lib/__init__.py14
1 files changed, 13 insertions, 1 deletions
diff --git a/numpy/lib/__init__.py b/numpy/lib/__init__.py
index 906bede37..2db12d9a4 100644
--- a/numpy/lib/__init__.py
+++ b/numpy/lib/__init__.py
@@ -1,8 +1,20 @@
+"""
+**Note:** almost all functions in the ``numpy.lib`` namespace
+are also present in the main ``numpy`` namespace. Please use the
+functions as ``np.<funcname>`` where possible.
+
+``numpy.lib`` is mostly a space for implementing functions that don't
+belong in core or in another NumPy submodule with a clear purpose
+(e.g. ``random``, ``fft``, ``linalg``, ``ma``).
+
+Most contains basic functions that are used by several submodules and are
+useful to have in the main name-space.
+
+"""
from __future__ import division, absolute_import, print_function
import math
-from .info import __doc__
from numpy.version import version as __version__
# Public submodules