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

Change __future__ docs description to avoid confusion with concurrency futures #92760

Closed
wants to merge 8 commits into from

Conversation

arhadthedev
Copy link
Member

@arhadthedev arhadthedev commented May 13, 2022

Currently, the library index page describes __future__ as:

__future__ — Future statement definitions

However, it creates confusion with futures from the concurrency domain. So this PR changes the description to:

__future__ — Early access to language features created for future versions of Python

Edit: replaced with a shorter wording:

__future__ — Early access to future language features

Copy link
Member

@carljm carljm left a comment

Choose a reason for hiding this comment

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

Looks like an improvement to me.

Doc/library/__future__.rst Outdated Show resolved Hide resolved
Doc/library/__future__.rst Outdated Show resolved Hide resolved
Copy link
Member

@carljm carljm left a comment

Choose a reason for hiding this comment

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

LGTM!

@arhadthedev
Copy link
Member Author

Could anybody merge the PR if possible please? This is the last one after gh-92761 and gh-92762.

@JelleZijlstra
Copy link
Member

I don't find the current wording unclear, and the proposed new wording is so long that it will make the page title spill into multiple lines on many screens. If another core dev has a different opinion, I won't object to merging this though.

@JelleZijlstra JelleZijlstra removed their request for review July 23, 2022 00:28
@arhadthedev
Copy link
Member Author

arhadthedev commented Jul 24, 2022

@JelleZijlstra Will Early access to future language features be better?

Edit: for comparison:

original:  Future statement definitions
initial:   Early access to language features for future versions of Python
fixed:     Early access to future language features

@arhadthedev
Copy link
Member Author

Applied the shorter wording described above.

@arhadthedev arhadthedev changed the title Dissociate __future__ docs description from concurrency futures Change __future__ docs description to avoid confusion with concurrency futures Aug 25, 2022
@arhadthedev
Copy link
Member Author

Ping.

@JelleZijlstra
Copy link
Member

Sorry, I still don't see a reason for change here. I'm leaving this open in case another core dev thinks there's room for improvement, but I'm not planning to merge anything.

@arhadthedev arhadthedev deleted the doc-__future__ branch October 15, 2022 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants