Clean up release notes in preparation for v3 #2634
Conversation
|
Sounds like a good idea. I also stumbled across this issue because some old release notes link to sections in the docs that now describe very different behavior. |
34e3a6b to
a247299
Compare
|
+1 on doing this. Can we get this in tomorrow? |
afc5086 to
b381a3f
Compare
1ea059a to
2557f1a
Compare
2557f1a to
1b2af63
Compare
| @@ -0,0 +1,16 @@ | |||
| Release notes | |||
| ============= | |||
|
|
|||
There was a problem hiding this comment.
Let's seed the release note section for 3.0.1
.. release_3.0.1:
3.0.1 (unreleased)
------------------
...
There was a problem hiding this comment.
We shouldn't have the 3.0.1 title in the 3.0.0 release, so shouldn't we hold off here until after release?
There was a problem hiding this comment.
We typically seed the release notes with the next release so contributors have a spot to start adding release notes. We can do this right after the 3.0.0 release I suppose.
There was a problem hiding this comment.
In numcodecs, we also seed a section but without version number. https://github.com/zarr-developers/numcodecs/blob/main/docs/release.rst?plain=1#L16
There was a problem hiding this comment.
That's after a release is made, the notes for the current release don't have an unreleased section: https://numcodecs.readthedocs.io/en/stable/release.html
This cleans out the release notes page, in preparation for v3. I decided to:
Thoughts?