`stubgen` should also include docstrings

[robertaistleitner]

Feature

When generating *.pyi files, docstrings describing the contained classes, methods and members are not included in the file.

Pitch

In my opinion it would be helpful to have them and other tools for pyi generation do exactly this.

[sobolevn]

I think that it should be an option 🤔
Because, for example in https://github.com/python/typeshed/ we don't need docstrings.

I can imagine many users do not want that as well. But, as a configurable feature - why not?
Somethink like --include-docstrings

Are you interested in working on this? 🙂

[tttapa]

For what it's worth, sizmailov/pybind11-stubgen already supports extracting docstrings from C modules and including them in the stub files.

I think this would be most useful for external C or C++ modules, because some IDEs don't look for signatures or docstrings in compiled modules.
Using stubgen at least fixes autocomplete for compiled modules, but if the stub files don't include docstrings, IDEs might not show any documentation when hovering over the function/class/variable in the editor (unlike with plain Python modules).

For example, Pylance in VSCode doesn't show documentation for functions in compiled modules, even with stub files generated by stubgen.

[nschloe]

Subscribing and +1 on --include-docstrings. (My use case: Nuitka-compiled modules.)

[moi90]

Starting point would be: https://github.com/python/mypy/blob/master/mypy/stubgen.py

[robertaistleitner]

Thanks for making this happen @chylek and @ilevkivskyi! 🎉