-
Notifications
You must be signed in to change notification settings - Fork 81
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
Missing Docstrings #225
Comments
It looks like https://github.com/python/cpython/blob/master/Doc/c-api/intro.rst smbusmodule uses it here: |
puh, not sure we want to manage the docs all in C this way... that seems a bit tedious. |
Or another option would be to write stub python wrappers for the existing C function and classes with docstrings(seems a lot simpler to me). What do you think? |
Is the current type annotation solution good enough to close this? |
Nothing changed on the C side of things, so that is expected. Your editor should show the docs though. |
Using the help function the docstrings should be displayed.
It doesn't have docs string on the whole. I don't know how exactly to do on a C extension but it is possible(I tried it using Cython it works there). Also, the docs, instead of hardcoding in
.rst
files, auto-summary sphinx module must be used so that docstrings can be maintained in the source.The text was updated successfully, but these errors were encountered: