FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-135755: Document __future__.* and CO_* as proper Sphinx objects by encukou · Pull Request #135980 · python/cpython · GitHub

/ cpython Public

gh-135755: Document __future__.* and CO_* as proper Sphinx objects - #135980

Merged
encukou merged 4 commits into
python:mainfrom
encukou:CO_flags
Jul 7, 2025
Merged

gh-135755: Document __future__.* and CO_* as proper Sphinx objects#135980
encukou merged 4 commits into
python:mainfrom
encukou:CO_flags

Conversation

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

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.


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

encukou added docs Documentation in the Doc dir skip news needs backport to 3.13 bugs and security fixes labels Jun 26, 2025
encukou added the needs backport to 3.14 bugs and security fixes label Jun 26, 2025
github-project-automation Bot moved this to Todo in Docs PRs Jun 26, 2025
bedevere-app Bot mentioned this pull request Jun 26, 2025
39 tasks
Comment thread Doc/c-api/veryhigh.rst Outdated
encukou merged commit 2468aaf into python:main 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.
🐍🍒⛏🤖

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
…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 <encukou@gmail.com>

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

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.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 7, 2025

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.

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jul 7, 2025
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
…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 <encukou@gmail.com>
encukou added a commit that referenced this pull request Jul 7, 2025
…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 <encukou@gmail.com>
AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025
…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
…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
…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
…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 <encukou@gmail.com>
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
…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
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant


Back | FazBrowse Home | New Git URL