Skip to content

gh-100150: document that --without-doc-strings affects inspect.signature - #144746

Open
Gh-Novel wants to merge 2 commits into
python:mainfrom
Gh-Novel:fix-issue-100150
Open

Gh-Novel wants to merge 2 commits into
python:mainfrom
Gh-Novel:fix-issue-100150

Conversation

@Gh-Novel

@Gh-Novel Gh-Novel commented Feb 12, 2026 •

Copy link
Copy Markdown

Summary

Adds a note to the --without-doc-strings configure option documentation explaining that disabling docstrings also prevents inspect.signature() from retrieving signatures for built-in functions and methods implemented in C.

This happens because signatures for C builtins are embedded in their docstrings via the Argument Clinic tool (__text_signature__ attribute). When docstrings are stripped, the signature metadata is lost.

Changes

  • Added a .. note:: box to Doc/using/configure.rst under --without-doc-strings
  • Mentions inspect.signature(), help(), and third-party framework impact\n- Links to the Argument Clinic documentation in the devguide

Testing

  • Sphinx doc build passes with zero warnings
  • Verified len.__text_signature__ attribute exists in normal builds and would be None without doc strings

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

…signature

Add a note to the --without-doc-strings documentation explaining that
disabling docstrings also prevents inspect.signature() from retrieving
signatures for built-in functions and methods implemented in C, since
those signatures are embedded in their docstrings by Argument Clinic.
@github-actions

github-actions Bot commented May 6, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label May 6, 2026
@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Jun 9, 2026
@github-actions

Copy link
Copy Markdown

This PR is stale because it has been open for 90 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Sep 10, 2026
@Gh-Novel
Gh-Novel requested a review from itamaro as a code owner October 16, 2026 01:49
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35181635 | 📁 Comparing 39101d6 against main (d52dba3)

  🔍 Preview build  

1 file changed
± using/configure.html

@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Oct 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant