Skip to content

bpo-44693: Update __future__ entry in Doc/glossary.rst #27349

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jul 26, 2021
Merged

bpo-44693: Update __future__ entry in Doc/glossary.rst #27349

merged 4 commits into from
Jul 26, 2021

Conversation

StevenHsuYL
Copy link
Contributor

@StevenHsuYL StevenHsuYL commented Jul 25, 2021 •
edited by terryjreedy
Loading

Replace sentence with confusing "pseudo-module" with two sentences separating future statements and the future module.

https://bugs.python.org/issue44693

@StevenHsuYL
bpo-44693: Doc/glossary.rst
ad89384 
Update definition of the __future__ in the glossary.
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Jul 25, 2021
@StevenHsuYL
Update glossary.rst
8c11a1a 
Remove white space.
merwok
merwok reviewed Jul 25, 2021
View reviewed changes
Doc/glossary.rst Outdated
A pseudo-module which programmers can use to enable new language features
which are not compatible with the current interpreter.
A :ref:`future statement <future>`, "from __future__ import *feature*
...", directs the compiler to compile the current module using syntax or
Copy link
Member

Choose a reason for hiding this comment

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

Code can use three backticks ` rather than quote marks

Copy link
Member

Choose a reason for hiding this comment

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

I will look at the result either way. I will also move the paragraph break and remove the duplicate module reference that follows.

Copy link
Member

Choose a reason for hiding this comment

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

Two backticks, not one or three, are needed for inline code in .rst. I decided to remove ... from the quoted code; one interested in the full syntax will have to look at the doc. I also removed the paragraph break.

Copy link
Member

Choose a reason for hiding this comment

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

I changed *feature* to <feature> as the latter is, I believe, used more for a syntax variable.

@terryjreedy terryjreedy changed the title bpo-44693: Update definition of __future__ in Doc/glossary.rst bpo-44693: Update __future__ entry in Doc/glossary.rst Jul 25, 2021
@terryjreedy terryjreedy self-assigned this Jul 25, 2021
@terryjreedy terryjreedy added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Jul 25, 2021
@terryjreedy terryjreedy merged commit 0363a40 into python:main Jul 26, 2021
@miss-islington
Copy link
Contributor

Thanks @StevenHsuYL for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.9.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-27357 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Jul 26, 2021
@bedevere-bot
Copy link

GH-27358 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Jul 26, 2021
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 26, 2021
@StevenHsuYL @miss-islington
bpo-44693: Update __future__ entry in Doc/glossary.rst (pythonGH-27349)
6285fe0 
Replace sentence with confusing "pseudo-module" with two sentences
separating future statements and the __future__ module.

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 0363a40)

Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 26, 2021
@StevenHsuYL @miss-islington
bpo-44693: Update __future__ entry in Doc/glossary.rst (pythonGH-27349)
6502d04 
Replace sentence with confusing "pseudo-module" with two sentences
separating future statements and the __future__ module.

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 0363a40)

Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>
terryjreedy pushed a commit that referenced this pull request Jul 26, 2021
@miss-islington @StevenHsuYL
bpo-44693: Update __future__ entry in Doc/glossary.rst (GH-27349) (GH…
642d873 
…-27357)

Replace sentence with confusing "pseudo-module" with two sentences
separating future statements and the __future__ module.

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 0363a40)

Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>

Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>
terryjreedy pushed a commit that referenced this pull request Jul 26, 2021
@miss-islington @StevenHsuYL
bpo-44693: Update __future__ entry in Doc/glossary.rst (GH-27349) (GH…
4ce6c52 
…-27358)

Replace sentence with confusing "pseudo-module" with two sentences
separating future statements and the __future__ module.

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 0363a40)

Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>

Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@merwok merwok merwok left review comments

@terryjreedy terryjreedy terryjreedy left review comments

Assignees

@terryjreedy terryjreedy

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@StevenHsuYL @miss-islington @bedevere-bot @merwok @terryjreedy @the-knights-who-say-ni