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

PEP 674: Leave PyDescr_TYPE() unchanged #2277

Merged
merged 3 commits into from
Jan 26, 2022
Merged

PEP 674: Leave PyDescr_TYPE() unchanged #2277

merged 3 commits into from
Jan 26, 2022

Conversation

vstinner
Copy link
Member

No description provided.

pep-0674.rst Outdated Show resolved Hide resolved
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Minor wording suggestions

A

pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

A few more minor suggestions.

pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
@vstinner
Copy link
Member Author

Oh. I didn't expect so many reviews :-D @JelleZijlstra, @hugovk, @AA-Turner: Would you mind to review again the change?

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Thanks! Just some minor grammar/phrasing and clarity issues.

pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated


Backwards Compatibility
=======================

The proposed C API changes are backward incompatible on purpose.

At December 1, 2021, a code search on the PyPI top 5000 projects (4760
At January 26, 2022, a code search on the PyPI top 5000 projects (4762
projects in practice, others don't have a source archive) found that
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
projects in practice, others don't have a source archive) found that
projects in practice; others don't have a source archive) found that

Comma splice (grammar error)

pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
@CAM-Gerlach
Copy link
Member

Hey @vstinner I will re-review to cover anything you just added and update a few suggestions that got outdated due to the commit in the middle of my review, but just as a tip especially in situations like this, it if you batch-apply the GitHub suggestions we all made (even if then squash/fixup that commit into another), it makes it easier for reviewers since it auto-resolves and collapses the comments and avoids the need to manually re-review to check that they got applied correctly. Thanks!

@AA-Turner
Copy link
Member

collapses the comments

I collapsed all the ones Victor addressed

Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Looks good, thanks
A

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Some additional suggestions to update those that got outdated/I was unable to make, followups on what you added/changed and a couple other things I spotted.

pep-0674.rst Outdated
Comment on lines 19 to 21
Only 13 out of the top 5000 PyPI projects (0.3%) are affected by 2 macro
changes. Moreover, 22 projects just have to regenerate their Cython
code.
Copy link
Member

@CAM-Gerlach CAM-Gerlach Jan 26, 2022

Choose a reason for hiding this comment

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

Suggested change
Only 13 out of the top 5000 PyPI projects (0.3%) are affected by 2 macro
changes. Moreover, 22 projects just have to regenerate their Cython
code.
Only 13 out of the top 5000 PyPI projects (0.3%) are affected, and only by a
total of two of the macro changes. An additional 22 projects just have to
regenerate their Cython code.

Updating this suggestion to reflect the changes, and adding one other fix:

  • As a reader of the PEP, it confused me as to how there could be 22 projects that had to re-Cythonize, but only 13 that were affected.
  • Additionally, the wording surrounding the "two macro changes" was potentially unclear and could imply something other than you mean

pep-0674.rst Show resolved Hide resolved
pep-0674.rst Show resolved Hide resolved

These 14 projects only use 4 macros as l-value:
Of these 13 projects, only 2 macros are used as an l-value:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Of these 13 projects, only 2 macros are used as an l-value:
In these 13 projects, only 2 macros are used as an l-value:

Grammar

pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
pep-0674.rst Outdated Show resolved Hide resolved
@vstinner vstinner merged commit e3836e9 into python:main Jan 26, 2022
@vstinner vstinner deleted the pep674_descr branch January 26, 2022 22:10
@vstinner
Copy link
Member Author

Too many comments, latest comments are on outdated commits, so it's very confusing. I merged my PR. Thanks for reviews.

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Jan 26, 2022

Hey @vstinner , sorry for the confusion and the repeated rounds of suggestions by multiple reviewers, and thanks for bearing with us.

As a tip for the future, batch-applying the GitHub suggestions reviewers have left for you through GitHub's UI, as intended, will help avoid most of the issues and frustration on this PR, and make things easier for both you and reviewers in the future. Also, if you are going to make additional changes on a PR before it is ready for review and merge, using the "Draft" status when opening it or clicking "Convert to draft" below the reviewers list clearly signals to us to hold off on reviewing (or merging) it until you're ready for it and don't review to-be-outdated commits, avoiding extra work for both you and us.

It looks like only two changes (not mooted by #2280 ) were not in the merged PEP (both on lines touched by #2280, but that was merged before I submitted my review with those two suggestions). Neither are critical, and the PEP could use a copyediting/proofreading pass anyway, so I'll take care of that in a separate PR when I get to it—better than piling on more suggestions here, for sure 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants