Skip to content

bpo-40465: Document random module changes in 3.11 What's new #31818

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 1 commit into from
Mar 24, 2022

Conversation

hrnciar
Copy link
Contributor

@hrnciar hrnciar commented Mar 11, 2022

random
------

* The *population* parameter of :func: `random.sample` must be a sequence.
Copy link
Member

Choose a reason for hiding this comment

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

This should fix the docs build:

Suggested change
* The *population* parameter of :func: `random.sample` must be a sequence.
* The *population* parameter of :func:`random.sample` must be a sequence.

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

It is not a correct place for this note because it is not a new feature. From user's point of view it is a breaking change which can break a code that worked before (even if it issued deprecation warnings). It should be documented in sections "Porting to Python 3.11", subsection "Changes in the Python API" or in section "Removed" (different changes may be in different sections).

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@hrnciar hrnciar changed the title Document random module changes in 3.11 What's new bpo-40465: Document random module changes in 3.11 What's new Mar 21, 2022
@vstinner
Copy link
Member

@serhiy-storchaka:

It should be documented in sections "Porting to Python 3.11"

Done: @hrnciar moved the What's New entry to Porting to Python 3.11 > Changes in the Python API.

@serhiy-storchaka serhiy-storchaka merged commit 12c0012 into python:main Mar 24, 2022
@vstinner
Copy link
Member

This change is related to 70a071d

Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

Post-merge review (@serhiy-storchaka was faster than me :-)): LGTM! This change properly describes https://bugs.python.org/issue40465 changes.

@serhiy-storchaka
Copy link
Member

BTW it was first time I used GitHub client for Android.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting changes docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants