Skip to content

Docs for --without-doc-strings argument to configure should mention that builtins can't have their signatures analyzed #100150

@bigfootjon

Description

@bigfootjon

Documentation

In the documentation for ./configure the --without-doc-strings option does not mention that removing docstrings also makes it impossible to use the inspect module to get the signature for builtins.

This seems to be an intentional limitation:

I opened a ticket about a downstream problem due to this in the Django project and there was some confusion about what this compile-time option does.

Can the documentation be improved to mention this? The current docs discuss the docstrings limitation but unless you know about the internals of CPython it can be unclear why this would also make it impossible to inspect builtins.

I’m happy to file an PR to update the text in the docs to discuss this limitation, though I may not fully understand the scope of the problem or what else should be mentioned there.

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions