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.

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

Jump to bottom

Consider if we should enable embedsignature #3

Open
segevfiner opened this issue Nov 2, 2021 · 1 comment
Open

Consider if we should enable embedsignature #3

segevfiner opened this issue Nov 2, 2021 · 1 comment

Comments

@segevfiner
Copy link
Owner

https://cython.readthedocs.io/en/latest/src/userguide/source_files_and_compilation.html#compiler-directives
@segevfiner segevfiner changed the title Conside if we should enable embedsignature Consider if we should enable embedsignature Nov 13, 2021
@segevfiner
Copy link
Owner Author

IPython will just display the signatures in the docstring.

Sphinx's autodoc will try to use them as the signature (Only if no annotations hopefully...), but they also include Cython syntax which Sphinx doesn't understand or strip.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@segevfiner