Missing Docstrings

[naveen521kk]

Using the help function the docstrings should be displayed.

>>> import cairo
>>> help(cairo.Context)
[...]

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.

[stuaxo]

It looks like PyDoc_STRVAR is the thing to achieve this with.

https://github.com/python/cpython/blob/master/Doc/c-api/intro.rst https://www.python.org/dev/peps/pep-0007/

smbusmodule uses it here: https://github.com/pimoroni/py-smbus/blob/master/library/smbusmodule.c

[lazka]

puh, not sure we want to manage the docs all in C this way... that seems a bit tedious.

[naveen521kk]

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?

[lazka]

Is the current type annotation solution good enough to close this?

[stuaxo]

Still looks a bit sparse here -

[lazka]

Nothing changed on the C side of things, so that is expected. Your editor should show the docs though.

[stuaxo]

Looks good -