Skip to content

Commit b452ca8

Browse files
committed
Update changelog
1 parent 6e14fc2 commit b452ca8

File tree

1 file changed

+23
-19
lines changed

1 file changed

+23
-19
lines changed

doc/changelog.rst

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,15 @@ for minor releases, see the `release page <https://github.com/fooof-tools/fooof/
99
1.0.0
1010
-----
1111

12-
Warning: the 1.X.X release series is an API breaking release from prior versions (0.X.X).
12+
Warning: the 1.X.X release series is an API breaking release from the prior versions,
13+
in the beta series (0.X.X).
1314

14-
Some names and module organizations have changed, which means existing code may no longer
15-
work as currently written when updating to the new version. You should only update
16-
if and when you are ready to update your code to reflect the new changes.
15+
The 1.X.X release series of FOOOF is the current stable version of the module.
16+
17+
As compared to the prior series (0.X.X), some names and module organizations have changed.
18+
This means existing code that uses FOOOF may no longer work as currently written with the
19+
new version, and may need updating. You should update to the new version when you are ready to
20+
update your code to reflect the new changes.
1721

1822
Note that the main changes are in code organization, some names, and the addition of
1923
many new features. The fitting algorithm itself has not changed, and model results fit
@@ -24,7 +28,7 @@ identical to prior fits.
2428
Code Organization
2529
~~~~~~~~~~~~~~~~~
2630

27-
The internal organization of the module has been changed.
31+
The internal organization of the module has changed with the 1.X.X series.
2832

2933
These internal organization changes mostly reflect turning internal files into
3034
sub-modules. Overall, this means that although the main functions and objects can
@@ -36,9 +40,12 @@ To see the new names and organization of the module, check the
3640
Naming Updates
3741
~~~~~~~~~~~~~~
3842

39-
One of the major changes is name changes of some elements in the module.
43+
There are a series of name changes with the new 1.X.X series.
44+
45+
These name changes were done to update the module to reflect the current vocabulary
46+
and conceptual ideas relating to work on parameterizing neural power spectra.
4047

41-
The following are the main name changes:
48+
The main name changes are:
4249

4350
- the `synth` module is now called them `sim` module
4451
- references to `background` are now called `aperiodic`
@@ -55,7 +62,7 @@ The following are the main name changes:
5562
Code Updates
5663
~~~~~~~~~~~~
5764

58-
This version adds a large number of code updates & additions, including:
65+
The 1.X.X series adds a large number of code updates & additions, including:
5966

6067
- A big extension of the plotting sub-module
6168
- Adding new functions to manipulate, manage, organize and manage FOOOF objects
@@ -64,8 +71,6 @@ This version adds a large number of code updates & additions, including:
6471
- Extra methods on FOOOF & FOOOFGroup objects for managing data & results
6572
- Miscellaneous bug fixes & other additions
6673

67-
To see all the new features in FOOOF, check out the API page on the documentation site.
68-
6974
The full history of changes is available in the Github commit and pull request history.
7075

7176
The bulk of the updates for 1.X.X went through in the following pull requests:
@@ -79,12 +84,12 @@ The bulk of the updates for 1.X.X went through in the following pull requests:
7984
Documentation Updates
8085
~~~~~~~~~~~~~~~~~~~~~
8186

82-
The 1.X.X series comes with a greatly updated documentation site.
87+
The 1.X.X series comes with an updated documentation site.
8388

84-
As well as updating the tutorials, API list, and other existing documentation, there is also a
85-
large amount of new materials, including:
89+
As well as updating the tutorials, API list, and other existing documentation, there are
90+
also new materials, including:
8691

87-
- new examples, including those covering new functionality
92+
- new examples, including new pages that cover new functionality
8893
- a new 'motivations' section, exploring why 'parameterizing neural power spectra' is a useful idea & method
8994
- new or updated sections on frequently asked questions, a module glossary, and how to reference the module
9095

@@ -103,11 +108,10 @@ the name of `min_peak_amplitude` to `min_peak_height` as well.
103108
0.1.X
104109
-----
105110

106-
The 0.1.X series of releases for FOOOF was the initial release beta series of FOOOF.
107-
108-
This series a different naming scheme and module organization to th current 1.X.X series.
111+
The 0.1.X series was the initial release series of beta versions of the FOOOF module.
109112

110-
This series is now deprecated.
113+
The old series of releases has a different naming scheme and module organization to the
114+
current 1.X.X series, and is now deprecated, with no plans to update or maintain this version.
111115

112-
These releases can still be accessed, and are described, on the
116+
These releases are described, and can still be accessed, on the
113117
`release page <https://github.com/fooof-tools/fooof/releases>`_

0 commit comments

Comments
 (0)