Skip to content

gh-110893: Improve the documentation for __future__ module #114642

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
Jan 29, 2024

Conversation

hauntsaninja
Copy link
Contributor

@hauntsaninja hauntsaninja commented Jan 27, 2024

nedbat took issue with the phrasing "real module". I'm actually fine with that phrasing, but I do think the __future__ page should be clear about the way in which the __future__ module is special. (Yes, there was a footnote linking to the future statements part of the reference, but there should be upfront discussion).

I'm sympathetic to nedbat's claim that no one really cares about __future__._Feature, so I've moved the interesting table up to the top.


📚 Documentation preview 📚: https://cpython-previews--114642.org.readthedocs.build/

nedbat took issue with the phrasing "real module". I'm actually fine
with that phrasing, but I do think the `__future__` page should be clear
about the way in which the `__future__` module is special. (Yes, there
was a footnote linking to the future statements part of the reference,
but there should be upfront discussion).

I'm sympathetic to nedbat's claim that no one really cares about
`__future__._Feature`, so I've moved the interesting table up to the
top.
Copy link
Member

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

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

I like this improvement. Note though #112348 is also open and makes additional (possibly gratuitous) changes.

@hauntsaninja hauntsaninja merged commit 3b86891 into python:main Jan 29, 2024
@hauntsaninja hauntsaninja deleted the gh110893 branch January 29, 2024 09:37
@miss-islington-app
Copy link

Thanks @hauntsaninja for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 29, 2024
…honGH-114642)

nedbat took issue with the phrasing "real module". I'm actually fine
with that phrasing, but I do think the `__future__` page should be clear
about the way in which the `__future__` module is special. (Yes, there
was a footnote linking to the future statements part of the reference,
but there should be upfront discussion).

I'm sympathetic to nedbat's claim that no one really cares about
`__future__._Feature`, so I've moved the interesting table up to the
top.
(cherry picked from commit 3b86891)

Co-authored-by: Shantanu <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 29, 2024
…honGH-114642)

nedbat took issue with the phrasing "real module". I'm actually fine
with that phrasing, but I do think the `__future__` page should be clear
about the way in which the `__future__` module is special. (Yes, there
was a footnote linking to the future statements part of the reference,
but there should be upfront discussion).

I'm sympathetic to nedbat's claim that no one really cares about
`__future__._Feature`, so I've moved the interesting table up to the
top.
(cherry picked from commit 3b86891)

Co-authored-by: Shantanu <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Jan 29, 2024

GH-114702 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Jan 29, 2024
@bedevere-app
Copy link

bedevere-app bot commented Jan 29, 2024

GH-114703 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Jan 29, 2024
hauntsaninja added a commit that referenced this pull request Jan 29, 2024
…-114642) (#114703)

gh-110893: Improve the documentation for __future__ module (GH-114642)

nedbat took issue with the phrasing "real module". I'm actually fine
with that phrasing, but I do think the `__future__` page should be clear
about the way in which the `__future__` module is special. (Yes, there
was a footnote linking to the future statements part of the reference,
but there should be upfront discussion).

I'm sympathetic to nedbat's claim that no one really cares about
`__future__._Feature`, so I've moved the interesting table up to the
top.
(cherry picked from commit 3b86891)

Co-authored-by: Shantanu <[email protected]>
hauntsaninja added a commit that referenced this pull request Jan 29, 2024
…-114642) (#114702)

gh-110893: Improve the documentation for __future__ module (GH-114642)

nedbat took issue with the phrasing "real module". I'm actually fine
with that phrasing, but I do think the `__future__` page should be clear
about the way in which the `__future__` module is special. (Yes, there
was a footnote linking to the future statements part of the reference,
but there should be upfront discussion).

I'm sympathetic to nedbat's claim that no one really cares about
`__future__._Feature`, so I've moved the interesting table up to the
top.
(cherry picked from commit 3b86891)

Co-authored-by: Shantanu <[email protected]>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…hon#114642)

nedbat took issue with the phrasing "real module". I'm actually fine
with that phrasing, but I do think the `__future__` page should be clear
about the way in which the `__future__` module is special. (Yes, there
was a footnote linking to the future statements part of the reference,
but there should be upfront discussion).

I'm sympathetic to nedbat's claim that no one really cares about
`__future__._Feature`, so I've moved the interesting table up to the
top.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants