Menu
I would like to use Google style docstrings for Python. I've specified that Pycharm should expect Google docstrings:
For some reason PyCharm will not show my docstrings in tooltips:
I'm referencing the examples here for the proper Google docstring format: http://www.sphinx-doc.org/en/stable/ext/example_google.html
It's unclear to me why PyCharm is not displaying my docstrings.
810
Press Ctrl+Alt+S and go to Editor | General |Smart Keys. Select the Insert type placeholders checkbox in the Smart Keys page of the editor settings. Place the caret at the function name, and press Alt+Enter . In the list of intention actions that opens, choose Insert documentation string stub.
Declaring Docstrings: The docstrings are declared using ”'triple single quotes”' or “””triple double quotes””” just below the class, method or function declaration. All functions should have a docstring.
Docstrings are accessible from the doc attribute (__doc__) for any of the Python objects and also with the built-in help() function. An object's docstring is defined by including a string constant as the first statement in the object's definition.
To generate docutils documentationSelect DocUtil task run/debug configuration, and change it as required: specify the configuration name, input and output directories, and optional keys. Launch this run/debug configuration, as described in the section Run and rerun applications.
After contacting JetBrains they notified me that this was a known problem: https://youtrack.jetbrains.com/oauth?state=%2Fissue%2FPY-22445
The solution is to update the "pockets" package.
They plan to fix in next release.
Issue is due to using python version 3.6!
116
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
