Some examples would be: * Pydoc does not generate documentation from stub files * Jupyter Notebooks don't show documentation from stub files (when using its shift+tab)
There is a better way to grasp this problem. Consider you are developing some big library with stub files. .pyi files contain more function definitions than .py because some definitions are generated. So it is natural to write docstrings in .pyi files, just like we do in C++ .h files. The problem is there is no PEP or some other piece of Python documentation which states that is OK to write docstrings in .pyi files. _______________________________________________ Python-ideas mailing list -- python-ideas@python.org To unsubscribe send an email to python-ideas-le...@python.org https://mail.python.org/mailman3/lists/python-ideas.python.org/ Message archived at https://mail.python.org/archives/list/python-ideas@python.org/message/QKSV3UTEVG6XXQXW2BPGUF6UXBKCDAMW/ Code of Conduct: http://python.org/psf/codeofconduct/
