Skip to content
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.

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

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

Open
bigfootjon opened this issue Dec 9, 2022 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@bigfootjon
Copy link
Contributor

bigfootjon commented Dec 9, 2022

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.

@bigfootjon bigfootjon added the docs Documentation in the Doc dir label Dec 9, 2022
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
Projects
None yet
Development

No branches or pull requests

1 participant