Skip to content

PEP 484: Change the consent requirement to be informational #1218

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

Merged
merged 3 commits into from
Nov 5, 2019

Conversation

JelleZijlstra
Copy link
Member

Following discussion on the typing-sig mailing list. cc @srittau @gvanrossum

Following discussion on the typing-sig mailing list. cc @srittau @gvanrossum
@JelleZijlstra
Copy link
Member Author

I'm not wedded to the exact wording here; alternative suggestions are welcome.

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

I'm personally in favor, and I recommend that the SC approve this change. There's an SC meeting this afternoon and this is on the agenda (I have to miss the meeting myself, but Brett will be attending).

@srittau
Copy link
Contributor

srittau commented Oct 29, 2019

I was not aware that this was in PEP 484. Would it make more sense to remove this sentence from the PEP completely and let the typeshed project handle it. This gives us more flexibility for a policy change in the future. I am not aware of the history of this sentence and its background, though.

Edit: I just caught up with the typing-sig thread, and the answers are contained in there. I am fine with the new wording.

@brettcannon brettcannon self-requested a review October 29, 2019 21:43
@brettcannon
Copy link
Member

I agree with @srittau that the sentence should just be removed and let typeshed handle any decision as to whether the owner is notified (the currently wording makes it a requirements instead of a suggestion, which would mean providing type hints to an orphaned project could not happen if the owner couldn't be reached).

And reword the next sentence so it still makes sense.
@JelleZijlstra
Copy link
Member Author

I removed the problematic sentence now and reworded the next sentence to reflect reality (in particular, I don't think we have decided on typeshed policies in the python-dev mailing list any time in the last few years).

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

OK, I can get behind this, sounds like Brett agrees too, so we'd only need one more person on the SC to agree.

@brettcannon
Copy link
Member

OK, steering council meeting just discussed this and the decision was to tweak the sentence to make type stubs an opt-out situation and not opt-in. So if a project wants to have their type stubs removed then typeshed is obliged to remove those stubs. Sorry to change this again, @JelleZijlstra , but that sentence change had unanimous support.

@gvanrossum
Copy link
Member

@brettcannon Can you provide Jelle with the exact sentence that the SC endorsed?

@brettcannon
Copy link
Member

@gvanrossum there wasn't an exact sentence, just to make opt-out possible.

@JelleZijlstra a suggestion from @ncoghlan was:
"Note that stubs for a given package will not be included here if the package owners have specifically requested that they be omitted."

@gvanrossum
Copy link
Member

Also once this is merged, the README (or something else?) in typeshed ought to be updated to reflect the change in policy.

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

With this change, I approve.

@JelleZijlstra
Copy link
Member Author

Thanks for making the change @gvanrossum, sorry I let this drop for a little while.

@gvanrossum
Copy link
Member

At this point it's up to @brettcannon to approve and merge.

@brettcannon brettcannon merged commit a2ae502 into python:master Nov 5, 2019
@brettcannon
Copy link
Member

LGTM and seems to align with what was asked for in the steering council meeting, so I've merged it!

srittau added a commit to srittau/typeshed that referenced this pull request Nov 6, 2019
This was discussed on the typing-sig mailing list and in
python/peps#1218, has met the approval of the steering council, and
was incorporated into PEP 484.

PEP 484 does not require the submitter to actively contact the library
owners, but I believe we should require this courtesy.
JelleZijlstra pushed a commit to python/typeshed that referenced this pull request Nov 7, 2019
This was discussed on the typing-sig mailing list and in
python/peps#1218, has met the approval of the steering council, and
was incorporated into PEP 484.
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.

5 participants