From 83e4b7257e14896cb5e538fe1ee0886870705953 Mon Sep 17 00:00:00 2001 From: Alessio Buccino Date: Fri, 15 Mar 2024 10:21:59 +0100 Subject: [PATCH 1/2] Clarify status of main and Sortinganalyzer --- README.md | 8 ++++++-- doc/index.rst | 8 ++++++++ 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ef4b45dd27..a0120bc9e3 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,11 @@ [![Twitter](https://img.shields.io/badge/@spikeinterface-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/spikeinterface) [![Mastodon](https://img.shields.io/badge/-@spikeinterface-%232B90D9?style=for-the-badge&logo=mastodon&logoColor=white)](https://fosstodon.org/@spikeinterface) -> :warning::warning::warning: **PRs with new features are frozen!**: after the 0.100.0 release, we will not accept PRs with new features (only bug fixes) until February 21st 2024. +> :warning::warning::warning: +> **New features under construction!** 🚧🚧🚧: after the 0.100.0 release (and related bug fixes), the next release will contain +> a major API improvement: the `SortingAnalyzer`. To read more about this, checkout the +> [enhancement proposal](https://github.com/SpikeInterface/spikeinterface/issues/2282) +> Please refer to the stable documentation [here](https://spikeinterface.readthedocs.io/en/0.100.1) SpikeInterface is a Python framework designed to unify preexisting spike sorting technologies into a single code base. @@ -70,7 +74,7 @@ With SpikeInterface, users can: ## Documentation -Detailed documentation of the latest PyPI release of SpikeInterface can be found [here](https://spikeinterface.readthedocs.io/en/0.100.0). +Detailed documentation of the latest PyPI release of SpikeInterface can be found [here](https://spikeinterface.readthedocs.io/en/0.100.1). Detailed documentation of the development version of SpikeInterface can be found [here](https://spikeinterface.readthedocs.io/en/latest). diff --git a/doc/index.rst b/doc/index.rst index 57ce14ed44..5a05b1314d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -13,6 +13,14 @@ With a few lines of code, SpikeInterface enables you to load and pre-process the state-of-the-art spike sorters, post-process and curate the output, compute quality metrics, and visualize the results. +.. warning:: + + **New features under construction!** 🚧🚧🚧: after the 0.100.0 release (and related bug fixes), the next release will contain + a major API improvement: the :code:`SortingAnalyzer`. To read more about this, checkout the + `enhancement proposal `_ + Please refer to the stable documentation `here `_ + + Overview of SpikeInterface modules ---------------------------------- From 1aedf95f1ce313b51139355bdeb78499b997044a Mon Sep 17 00:00:00 2001 From: Alessio Buccino Date: Fri, 15 Mar 2024 10:23:57 +0100 Subject: [PATCH 2/2] Typos --- README.md | 2 +- doc/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a0120bc9e3..746553e412 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ > :warning::warning::warning: > **New features under construction!** 🚧🚧🚧: after the 0.100.0 release (and related bug fixes), the next release will contain > a major API improvement: the `SortingAnalyzer`. To read more about this, checkout the -> [enhancement proposal](https://github.com/SpikeInterface/spikeinterface/issues/2282) +> [enhancement proposal](https://github.com/SpikeInterface/spikeinterface/issues/2282). > Please refer to the stable documentation [here](https://spikeinterface.readthedocs.io/en/0.100.1) diff --git a/doc/index.rst b/doc/index.rst index 5a05b1314d..957e761202 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -17,7 +17,7 @@ state-of-the-art spike sorters, post-process and curate the output, compute qual **New features under construction!** 🚧🚧🚧: after the 0.100.0 release (and related bug fixes), the next release will contain a major API improvement: the :code:`SortingAnalyzer`. To read more about this, checkout the - `enhancement proposal `_ + `enhancement proposal `_. Please refer to the stable documentation `here `_