GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-135755: Document __future__.* and CO_* as proper Sphinx objects by encukou · Pull Request #135980 · python/cpython

Conversation

@encukou

@encukou encukou commented Jun 26, 2025 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

__future__ feature descriptions and CO_ C macros were documented in prose, but lacked Sphinx markup that marked them as Python attributes and C macros. For example:

  • Searching for “nested scopes” yields full-text results only
  • Searching for “CO_GENERATOR” yields “inspect.CO_GENERATOR (Python data, in inspect — Inspect live objects)”, but no C API.

This affects users of the Intersphinx inventory as well.

This patch adds the Sphinx definintions, and puts them in list-tables to make the ReST more maintainabile.

  • Issue: Undocumented 3.14 C API #135755

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
encukou added 3 commits June 26, 2025 13:31
@encukou
Turn the __future__ table to list-table
875fbcb 
This'll make it easier to add entries that need longer markup
@encukou
Semantic markup for __future__ feature descriptions
26332da
@encukou
Document CO_* C macros
fd3ac0c
@encukou encukou added docs Documentation in the Doc dir skip news needs backport to 3.13 only security fixes labels Jun 26, 2025
@github-project-automation github-project-automation Bot added this to Docs PRs Jun 26, 2025
@encukou encukou added the needs backport to 3.14 bugs and security fixes label Jun 26, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jun 26, 2025
@bedevere-app bedevere-app Bot added the awaiting core review label Jun 26, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Jun 26, 2025
Undocumented 3.14 C API #135755
Closed
39 tasks done
encukou
encukou commented Jul 2, 2025
View reviewed changes
Comment thread Doc/c-api/veryhigh.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@encukou
Remove extra underscore
a265082
@encukou
encukou merged commit 2468aaf into python:main Jul 7, 2025
@miss-islington-app

miss-islington-app Bot commented Jul 7, 2025

Copy link
Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting core review label Jul 7, 2025
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 7, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 7, 2025
@encukou @miss-islington
pythongh-135755: Document __future__.* and CO_* as proper Sphinx obje…
5dd7426 
…cts (pythonGH-135980)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
(cherry picked from commit 2468aaf)

Co-authored-by: Petr Viktorin <[email protected]>
@miss-islington-app

miss-islington-app Bot commented Jul 7, 2025

Copy link
Copy Markdown

Sorry, @encukou, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 2468aafe984fdf923811ef0c6969e3d6c1b92a82 3.13
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington-app miss-islington-app Bot assigned encukou Jul 7, 2025
@bedevere-app

bedevere-app Bot commented Jul 7, 2025

Copy link
Copy Markdown

GH-136370 is a backport of this pull request to the 3.14 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 7, 2025
@bedevere-app

bedevere-app Bot commented Jul 7, 2025

Copy link
Copy Markdown

GH-136371 is a backport of this pull request to the 3.13 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only security fixes label Jul 7, 2025
@encukou
encukou deleted the CO_flags branch July 7, 2025 10:35
encukou added a commit to encukou/cpython that referenced this pull request Jul 7, 2025
@encukou
[3.13] pythongh-135755: Document __future__.* and CO_* as proper Sphi…
42f49f7 
…nx objects (pythonGH-135980)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
(cherry picked from commit 2468aaf)

Co-authored-by: Petr Viktorin <[email protected]>
encukou added a commit that referenced this pull request Jul 7, 2025
@miss-islington @encukou
[3.14] gh-135755: Document __future__.* and CO_* as proper Sphinx obj…
5df4f35 
…ects (GH-135980) (GH-136370)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.

(cherry picked from commit 2468aaf)

Co-authored-by: Petr Viktorin <[email protected]>
AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025
@encukou @AndPuQing
pythongh-135755: Document __future__.* and CO_* as proper Sphinx obje…
94ed50e 
…cts (pythonGH-135980)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
@encukou @Pranjal095
pythongh-135755: Document __future__.* and CO_* as proper Sphinx obje…
1e71c1d 
…cts (pythonGH-135980)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
picnixz pushed a commit to picnixz/cpython that referenced this pull request Jul 13, 2025
@encukou @picnixz
pythongh-135755: Document __future__.* and CO_* as proper Sphinx obje…
e1b8d9d 
…cts (pythonGH-135980)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
encukou added a commit that referenced this pull request Aug 2, 2025
@encukou
[3.13] gh-135755: Document __future__.* and CO_* as proper Sphinx obj…
3b28cb0 
…ects (GH-135980) (GH-136371)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
(cherry picked from commit 2468aaf)

Co-authored-by: Petr Viktorin <[email protected]>
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
@encukou @taegyunkim
pythongh-135755: Document __future__.* and CO_* as proper Sphinx obje…
0060c64 
…cts (pythonGH-135980)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@encukou @Agent-Hellboy
pythongh-135755: Document __future__.* and CO_* as proper Sphinx obje…
d416b45 
…cts (pythonGH-135980)

* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@encukou encukou

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@encukou
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.