Skip to content

DOC: update 1.4.0 release notes#11061

Merged
tylerjereddy merged 1 commit intoscipy:masterfrom
tylerjereddy:relnotes_140
Nov 17, 2019
Merged

DOC: update 1.4.0 release notes#11061
tylerjereddy merged 1 commit intoscipy:masterfrom
tylerjereddy:relnotes_140

Conversation

@tylerjereddy
Copy link
Copy Markdown
Contributor

Starting to (slowly) build up the release notes. Starting off with a draft of the author list based off a commit hash range (24e65d0..347247f).

I'll try to ping those contributors with names listed that might benefit from remapping in the mailmap file.

@tylerjereddy tylerjereddy added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org needs-work Items that are pending response from the author labels Nov 15, 2019
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
* 30blay +
* @endolith
* @hugovk
* Abhinav +
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@abhinavsagar Preferred name?

* @hugovk
* Abhinav +
* Anne Archibald
* ashwinpathak20nov1996 +
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@ashwinpathak20 Preferred name?

* Anne Archibald
* ashwinpathak20nov1996 +
* Nelson Auner +
* aypiggott +
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@aypiggott preferred name?

Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
* mfkasim91 +
* michaelmarien +
* Kevin Michel +
* mikeWShef +
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@mikeWShef Preferred name?

Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
* stefan-endres +
* Kai Striega
* Søren Fuglede Jørgensen
* tborisow +
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@tborisow Preferred name?

* Kai Striega
* Søren Fuglede Jørgensen
* tborisow +
* tuxcell +
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@tuxcell Preferred name?

Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
@tylerjereddy
Copy link
Copy Markdown
Contributor Author

Updated with more complete draft of release notes---please do take a look, they are pretty long, probably still missing some things, and the choice of highlights is wonderful but difficult so input there is helpful.

Comment thread doc/release/1.4.0-notes.rst
@tylerjereddy
Copy link
Copy Markdown
Contributor Author

My next task here is to scan through the PRs with the 1.4.0 milestone labelled with enhancement, and fill in whatever might be missing. That is my project for this afternoon.

Comment thread doc/release/1.4.0-notes.rst
Comment thread doc/release/1.4.0-notes.rst Outdated
Comment thread doc/release/1.4.0-notes.rst Outdated
@rgommers
Copy link
Copy Markdown
Member

Looks good @tylerjereddy, thanks. Line wrapping at 80 characters would be nice.

Copy link
Copy Markdown
Contributor

@grlee77 grlee77 left a comment

Choose a reason for hiding this comment

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

What is here looks good. I wrote a description for a couple of the scipy.signal PRs I was involved with.

Comment thread doc/release/1.4.0-notes.rst
@tylerjereddy
Copy link
Copy Markdown
Contributor Author

Line wrapping at 80 characters would be nice.

Good idea, I've done that now---excluding the PR/issues lists if that's alright.

@rgommers
Copy link
Copy Markdown
Member

excluding the PR/issues lists if that's alright.

yes you're right, those are better left as is

@tylerjereddy tylerjereddy force-pushed the relnotes_140 branch 2 times, most recently from 098c822 to e48bec4 Compare November 16, 2019 23:05
@tylerjereddy
Copy link
Copy Markdown
Contributor Author

Updated after manual curation of Enhancement PRs merged for 1.4.0.

Comment thread doc/release/1.4.0-notes.rst
@rgommers
Copy link
Copy Markdown
Member

This is starting to look pretty complete

Comment thread doc/release/1.4.0-notes.rst Outdated
@tylerjereddy tylerjereddy marked this pull request as ready for review November 17, 2019 00:41
@tylerjereddy
Copy link
Copy Markdown
Contributor Author

Probably a few last minute merges have escaped capture here. Feel free to suggest those updates, otherwise I'll probably have to do another pass on the scraping scripts.

@tylerjereddy tylerjereddy changed the title WIP, DOC: update 1.4.0 release notes DOC: update 1.4.0 release notes Nov 17, 2019
@tylerjereddy tylerjereddy removed the needs-work Items that are pending response from the author label Nov 17, 2019
@tylerjereddy
Copy link
Copy Markdown
Contributor Author

I've updated with another fresh pass using the author & issue/PR lists scripts. Update was pretty clean--one new author & a few issues/PRs from last minute merges.

Comment thread doc/release/1.4.0-notes.rst Outdated
@rgommers
Copy link
Copy Markdown
Member

If people don't respond about preferred name, I would suggest to use what's on their GitHub profile or in their email address. If you can be reasonably certain, that's better than a GitHub handle. This is what I've always done in the past.

Comment thread doc/release/1.4.0-notes.rst Outdated
* update .mailmap based on contributor
preference/feedback

* populate the author list for 1.4.0 release
notes

* populate the Issue and PR lists for 1.4.0
release

* draft the release highlights section

* transcribe content from the Release Notes
Wiki that was not already present

* address several reviewer comments, including
line wrapping at 80 characters (with the exception
of the issue/PR lists)

* manually curated the release notes by adding in
Enhancement entries labelled for 1.4.0 on GitHub
that were not mentioned yet
@tylerjereddy
Copy link
Copy Markdown
Contributor Author

If people don't respond about preferred name, I would suggest to use what's on their GitHub profile or in their email address

I made another manual pass---it still isn't perfect, but fairly solid now I'd say apart from a few "ghosts."

@tylerjereddy
Copy link
Copy Markdown
Contributor Author

The lists should all be up-to-date for 7095a04, which should be the last code change in master before the release notes, I'd say.

@tylerjereddy
Copy link
Copy Markdown
Contributor Author

Ok, I need to branch and I've resolved the comments so far for this DOC PR. CircleCI stuff is related to last-minute merging I think.

So, merging the release notes.

@tylerjereddy tylerjereddy merged commit f507f04 into scipy:master Nov 17, 2019
@tylerjereddy tylerjereddy deleted the relnotes_140 branch November 17, 2019 05:02
@rgommers
Copy link
Copy Markdown
Member

The build_docs CI jobs is failing because of some link issues in this PR, guess that needs fixing on both branches now.

@fuglede
Copy link
Copy Markdown
Contributor

fuglede commented Nov 18, 2019

Note sure if this is a helpful comment or not, but: Some function references use single backticks, while others (in the scipy.signal and scipy.stats sections) use :func:.

Similarly, just by pattern matching, I would expect that the reference to scipy.stats.reciprocal should have only single backticks and not double ones.

@rgommers
Copy link
Copy Markdown
Member

Thanks @fuglede, it is. :func: should never be needed, and is annoying because we need to use the plain-text version of the release notes in a couple of places.

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.