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

Get help text #35

Open

kwabenantim opened this issue Mar 22, 2024 · 1 comment

Assignees

Labels

documentation enhancement

Member

kwabenantim commented Mar 22, 2024 •

edited

Loading

Summary

Retrieve Python help text from C++ docstrings.

Useful docs:

https://pybind11.readthedocs.io/en/stable/advanced/misc.html#generating-documentation-using-sphinx

kwabenantim added enhancement documentation labels

kwabenantim self-assigned this

Member Author

kwabenantim commented Mar 22, 2024

Currently, Python help text is empty. For example:

.def("bar", double &Foo, " " )  // help text should be in the blank " "

If the C++ code has an attached docstring, it would be useful to read it into the class or function wrapper definition.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment