In this post I'll give a little advice how to configure PyCharm IDE to create reStructuredText docstrings.
reStructuredText is a powerful and convenient format that is widely used in Python community.
If you use PyCharm, to increase your documentation writing productivity you can do the following thing.
Declare variable __docformat__ = 'restructuredtext en' at the begging of the source file. After that you can either type """ and Enter or press Alt+Enter and select "Insert documentation string stub"
After that you will see nice document stub created by PyCharm.
Good luck.
reStructuredText is a powerful and convenient format that is widely used in Python community.
If you use PyCharm, to increase your documentation writing productivity you can do the following thing.
Declare variable __docformat__ = 'restructuredtext en' at the begging of the source file. After that you can either type """
After that you will see nice document stub created by PyCharm.
If you don't want to write same line again and again in each new file, you can add change Python source file template: File->Settings->File Templates->Python Script.
This comment has been removed by the author.
ReplyDelete