Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: SciPy 1.11.0 release notes #18563

Merged
merged 6 commits into from May 29, 2023

Conversation

tylerjereddy
Copy link
Contributor

@tylerjereddy tylerjereddy commented May 27, 2023

  • add draft author list, and fix broken .mailmap file (Zoufiné Lauer-Bare had an invalid entry)
  • add draft issue/PR lists
  • transcribe/reformat wiki release notes to the rst format
  • manually scan the 118 merged enhancement PRs, and update any missing entries in the release notes
  • fixes from checking doc build locally: python dev.py doc html -j 12

TODO:

  • release notes highlights, probably with help from the folks sprinting on sparse arrays, and something for the enormous volume of stats work done
  • there's still a lot of activity happening, so probably another round or two of updates to merged PRs
  • check for old/merged PRs missing the milestone
  • more .mailmap updates
  • deal with the remaining pending PRs with a milestone... there are 7 at the time of writing, but I'm probably out of energy for those today.

* add draft author list, and fix broken `.mailmap`
file (Zoufiné Lauer-Bare had an invalid entry)

* add draft issue/PR lists

* transcribe/reformat wiki release notes to the rst
format

* manually scan the 118 merged `enhancement` PRs, and
update any missing entries in the release notes

* fixes from checking doc build locally:
`python dev.py doc html -j 12`

[skip actions] [skip cirrus]
@tylerjereddy tylerjereddy added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label May 27, 2023
@tylerjereddy tylerjereddy added this to the 1.11.0 milestone May 27, 2023
@tylerjereddy
Copy link
Contributor Author

@perimosocordiae said he'd try to help me document the recent sparse updates

doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved



*******
Authors
*******

* h-vetinari (69)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other single-name users seem to be sorted alphabetically, not sure what's going on there; I'm also really surprised by my supposed commit count, it should be around half that:

git shortlog -sn --no-merges tags/v1.10.0..6d9754182e5f65540957ade962cd3689eacd3599 | grep -i "vetinari"
    34  @h-vetinari

(with merges it's 36)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe that's something you can discuss with @tupui re: the machinery that calculates this in tools/authors.py. I'm not sure the commit counts are that useful anyway, but I probably won't have the bandwidth to debug at this time.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's also looking at the message to find if the name is thanked or in co-authored. So the number here should be greater or equal than the actual numbers of commit you got yourself in the history.

Copy link
Contributor

@mdhaber mdhaber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a real review yet. Just saving my state. I need to clean this up later.
gh-18227
gh-18210
Stopped on this page, 18196. Change name to logrank.

doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
Comment on lines 230 to 231
Deprecated features
*******************
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stefanv could you suggest an entry for your recent sparse deprecation

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! It's holiday in the US Monday, so if this can happen on Tuesday that'd be great.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CJ drafted some deprecations in, and I added a few more locally based on the sprint notes/PRs, that I'll push shortly. I'll welcome refinements even after I branch, so a PR can be opened later.

doc/source/release/1.11.0-notes.rst Outdated Show resolved Hide resolved
@tylerjereddy
Copy link
Contributor Author

I still plan to branch on May 29th at some reasonable hour of US Mountain Time. I'll try to make a few more rounds of improvements here, check the sparse notes on the HackMD for the recent sprint, etc., but I do expect the release notes to mutate a bit during the RC phase because of the volume of last minute changes.

DOC: stats: improve 1.11.0 stats release notes
@tylerjereddy
Copy link
Contributor Author

I merged Matt's PR to my branch in. Feel free to ping me directly if you make such a PR so I see it right away on my phone tomorrow.

@perimosocordiae
Copy link
Member

For reference, here are the final notes on scipy.sparse changes from the Summit last week: https://hackmd.io/@y1KjxOX0RyaAGSI6B4cY0g/B1Y47nAHh

tylerjereddy and others added 2 commits May 29, 2023 13:11
* apply reviewer suggestions in cases where it was possible to do
directly via the GH interface

[skip actions] [skip cirrus]

Co-authored-by: Ilhan Polat <ilhanpolat@gmail.com>
Co-authored-by: CJ Carey <perimosocordiae@gmail.com>
Co-authored-by: Matt Haberland <mhaberla@calpoly.edu>
* address suggestions from code review

[skip actions] [skip cirrus]
* formatting cleanup for `sparse` section, and
move deprecation information to the appropriate
section + expand it

* draft the release highlights

* some line length cleanups and removal of
empty sections

* re-run author and issue/PR list scripts

[skip actions] [skip cirrus]
@tylerjereddy tylerjereddy changed the title WIP, DOC: SciPy 1.11.0 release notes DOC: SciPy 1.11.0 release notes May 29, 2023
@tylerjereddy
Copy link
Contributor Author

I wrote a first draft of the release highlights and made a bunch of other cleanups to the release notes. The rendered version of the notes looks nice locally.

Of course, there is always room for improvement, but if the CI passes here I'm likely to merge and move forward with the branching timeline, with release notes refinements accepted before RC1 on Wednesday and where needed during the RC phase.

@tylerjereddy tylerjereddy merged commit d0510af into scipy:main May 29, 2023
6 checks passed
@tylerjereddy tylerjereddy deleted the treddy_1_11_relnotes branch May 29, 2023 21:31
@mdhaber
Copy link
Contributor

mdhaber commented Jun 1, 2023

Presumably there will be a PR for updates at some point, into which we can merge https://github.com/mdhaber/scipy/tree/gh18563.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants