-
-
Notifications
You must be signed in to change notification settings - Fork 10.9k
MAINT: Clean up more PY_VERSION_HEX #15233
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The additional changes (and the old changes, with the assumption that they are identical) look good to me. @mattip can you briefly confirm that the PyPy version removal is correct?
I think the PyPy stanza should stay for another release or two, if it is not too painful. Also would be good to add a release note. |
c1038ca
to
a7d29ce
Compare
@mattip I added doc/release/upcoming_changes/15233.compatibility.rst with some generic words. Is there a document about writing release notes for numpy? e.g. what sections things belong in? length? what tense to write in? Thanks |
There is a readme in the directory with the notes. It does not dive into style, you can take your cue from the other release notes. I think we should edit the 15229 note, change it to a |
@mattip Sounds reasonable. I figure the main purpose of the release notes to inform folks of new functionality, give them a first place to look if they run into problems, and supply a bit of community news so they can see what the project is up to. I think the Python 2 cleanup qualifies. |
aaf2431
to
30c16ac
Compare
The most noticeable change might be to |
I updated the release note to be a highlight and added two bullet points that cover the major scope of my work. |
6ca8e4a
to
47eb572
Compare
I haven't been able to get I also tried looking for a recent highlight.rst and didn't find one (e.g. Any help would be appreciated |
``NPY_PY3K`` was removed. This should have no effect on Python 3.5+. | ||
|
||
* A number of Py3k compatible structure have been simplified or removed. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is rst. The continuation lines of the bullet list must be indented to match the first line:
* As part ...
this line is indented two spaces
But I think as a highlight, this should be something like "Code compatibility with Python versions < 3.5
(including Python 2) was dropped from both python and C. The shims in numpy.compat
will remain to support third-party packages, but they may be deprecated in a future release."
Then, if you want, you can add another compatibility
note like 15229.compatibility.rst
for this PR
You might find the 'how to build documentation` more helpful, but it is missing the crucial part: you need to use towncrier to convert the release fragments into a release note. This is doen by a separate command using towncrier (but that workflow could use some more details):
Then you can check the file doc/source/relelase/1.19.0-notes.rst. The command will also add the new file to git, so be sure to remove it
|
14ea01c
to
a8d1da8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mattip I didn't see (till now) your suggestion to merge 15229.compatibility.rst and .highlight.rst.
I'm not feeling confident in my ability to write doc notes about these changes. Would it be acceptable to submit this (with your suggested highlights) and a few Py3K PRs then come back and see if there is a better holistic highlight?
Lets not worry too much about the highlights. May be useful before the end to list things as highlights. But I think we will probably manually edit at least the highlights before any release. |
Thanks @sethtroisi |
Building on #15232