Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Gh-Novel wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Doc/using/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -813,6 +813,17 @@ also be used to improve performance.

See the ``PyDoc_STRVAR()`` macro.

.. note::

Disabling doc strings also means that :func:`inspect.signature` cannot
retrieve signatures for built-in functions and methods implemented in C,
since the signatures for these functions are embedded in their docstrings
(generated by `Argument Clinic
<https://devguide.python.org/development-tools/clinic/>`_). This may
affect tools and libraries that rely on introspecting built-in callables,
such as :func:`help` and some third-party frameworks.


.. option:: --enable-profiling

Enable C-level code profiling with ``gprof`` (disabled by default).
Expand Down
Loading