From c1d4e776440642b9fc38d035fa7a87facc19445d Mon Sep 17 00:00:00 2001 From: Philipp Schlegel Date: Thu, 11 Nov 2021 15:22:42 +0000 Subject: [PATCH] README: add version 1.0.0 warning --- README.md | 5 ++++- docs/source/whats_new.rst | 4 +++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 581110ce..bd551e64 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,15 @@ - NAVis is a Python 3 (3.7 or later) library for **N**euron **A**nalysis and **Vis**ualization. ## Documentation NAVis is on [ReadTheDocs](http://navis.readthedocs.io/ "NAVis ReadTheDocs"). +Version `1.0.0` comes with some breaking changes! Please check out the +[changelog](https://navis.readthedocs.io/en/latest/source/whats_new.html) for a +list of relevant changes. + ## Features * work in Jupyter or terminal * support for various neuron types: **skeletons**, **meshes**, **dotprops**, **voxels** diff --git a/docs/source/whats_new.rst b/docs/source/whats_new.rst index a3881d9a..c035047a 100644 --- a/docs/source/whats_new.rst +++ b/docs/source/whats_new.rst @@ -16,6 +16,8 @@ repository. - * - dev - In development + * - 1.0.0 + - 11/11/21 - - :class:`~navis.NeuronList`: - :meth:`~navis.NeuronList.apply` now allows omitting failures (see ``omit_failures`` parameter) - :class:`~navis.VoxelNeuron`: @@ -56,7 +58,7 @@ repository. - new `k3d `_ backend for plotting in Jupyter environments: try ``navis.plot3d(x, backend='k3d')`` - new parameter for :func:`~navis.plot2d` and :func:`~navis.plot3d`: use ``clusters=[0, 0, 0, 1, 1, ...]`` to assigns clusters and have them automatically coloured accordingly - - :func:`~navis.plot2d` now allows ``radius=True`` parameter + - :func:`~navis.plot2d` now allows ``radius=True`` parameter - renamed functions to make it clear they are only for ``TreeNeurons``: - ``smooth_neuron`` -> :func:`~navis.smooth_skeleton` - ``reroot_neuron`` -> :func:`~navis.reroot_skeleton`