Skip to content

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

Merged
terryjreedy merged 4 commits into
python:mainfrom
StevenHsuYL:bpo44693
Jul 26, 2021
Merged

bpo-44693: Update __future__ entry in Doc/glossary.rst#27349
terryjreedy merged 4 commits into
python:mainfrom
StevenHsuYL:bpo44693

Conversation

@StevenHsuYL

@StevenHsuYL StevenHsuYL commented Jul 25, 2021

Copy link
Copy Markdown
Contributor

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

https://bugs.python.org/issue44693

Update definition of the __future__ in the glossary.
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Jul 25, 2021
Remove white space.
Comment thread 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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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 merged commit 0363a40 into python:main Jul 26, 2021
@miss-islington

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

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

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 26, 2021
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
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
…-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
…-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

Labels

docs Documentation in the Doc dir

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants