python / python/cpython

Docs: problem with page "__future__ — Future statement definitions"

Open
#154,559 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Documentation

The page at https://docs.python.org/3/library/__future__.html has a problem:

"__future__.annotations | Never: PEP 563: Postponed evaluation of annotations, PEP 649: Deferred evaluation of annotations using descriptors"

This is incorrect though innit?

Isn't it "mandatory" in 3.14 - https://docs.python.org/3/reference/compound_stmts.html#annotations?

EDIT: Re-reading both the pages I think I was mistaken - but the page should still link to https://docs.python.org/3/reference/compound_stmts.html#annotations I suppose.

Linked PRs
  • gh-154608

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the future.annotations entry on the future documentation page with the annotations section linked from the language reference. The reported correction is to add that reference link if appropriate; issue gh-154608 is already linked, so check its status before starting.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.