Commit fadb5057 authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

DOC: Note change to native namespace package

parent 43154588
...@@ -10,7 +10,11 @@ order. ...@@ -10,7 +10,11 @@ order.
Changed Changed
^^^^^^^ ^^^^^^^
* The :mod:`fsl` package has been changed from being a `pkgutil-style
<https://packaging.python.org/guides/packaging-namespace-packages/#pkgutil-style-namespace-packages>`_
namespace package to now being a `native
<https://packaging.python.org/guides/packaging-namespace-packages/#native-namespace-packages>`_
namespace package.
* The :class:`.TaskThread` now allows an error handler function to be * The :class:`.TaskThread` now allows an error handler function to be
specified, which is run on the :mod:`.idle` loop. specified, which is run on the :mod:`.idle` loop.
* The :func:`.bids.loadMetadata` function no long resolves sym-links when * The :func:`.bids.loadMetadata` function no long resolves sym-links when
......
...@@ -11,7 +11,14 @@ ...@@ -11,7 +11,14 @@
fsl.version fsl.version
fsl.wrappers fsl.wrappers
.. automodule:: fsl
:members: The :mod:`fsl` package provides the top-level Python package namespace for
:undoc-members: ``fslpy``, and for other FSL python libaries. It is a `native namespace
:show-inheritance: package <https://packaging.python.org/guides/packaging-namespace-packages/>`_,
which means that there is no ``fsl/__init__.py`` file.
Other libraries can use the ``fsl`` package namepace simply by also omitting a
``fsl/__init__.py`` file, and by ensuring that there are no naming conflicts
with any sub-packages of ``fslpy`` or any other projects which use the ``fsl``
package namespace.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment