Skip to content

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

Closed
arhadthedev wants to merge 8 commits into
python:mainfrom
arhadthedev:doc-__future__
Closed

Change __future__ docs description to avoid confusion with concurrency futures#92760
arhadthedev wants to merge 8 commits into
python:mainfrom
arhadthedev:doc-__future__

Conversation

@arhadthedev

@arhadthedevarhadthedev commented May 13, 2022

Copy link
Copy Markdown
Member

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

@carljmcarljm left a comment

Copy link
Copy Markdown
Member

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.

Comment threadDoc/library/__future__.rst Outdated
Comment threadDoc/library/__future__.rst Outdated
arhadthedevand others added 2 commits May 17, 2022 20:21
Co-authored-by: Carl Meyer <carl@oddbird.net>

@carljmcarljm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@arhadthedev

Copy link
Copy Markdown
MemberAuthor

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

@JelleZijlstra

Copy link
Copy Markdown
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

arhadthedev commented Jul 24, 2022

Copy link
Copy Markdown
MemberAuthor

@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
Copy Markdown
MemberAuthor

Applied the shorter wording described above.

@arhadthedevarhadthedev changed the title Dissociate __future__ docs description from concurrency futuresChange __future__ docs description to avoid confusion with concurrency futuresAug 25, 2022
@arhadthedev

Copy link
Copy Markdown
MemberAuthor

Ping.

@JelleZijlstra

Copy link
Copy Markdown
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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting core reviewdocsDocumentation in the Doc dirneeds backport to 3.10only security fixesneeds backport to 3.11only security fixesskip issueskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@arhadthedev@JelleZijlstra@carljm@bedevere-bot@AlexWaygood