Changer le format reStructuredText dans PyCharm des commentaires générés automatiquement

Question

La documentation de dit JetBrains, qu'il existe deux formats pour créer reStructuredText comments with type-hinting:

:param param_type param_name: parameter description (type description is on the same line as the parameter description). 
:type param_name: param_type (type description is on a separate line) 

Il y avait une certaine manière, la façon dont vous pouvez sélectionner l'un ou l' autrement comment les commentaires ont été générés, mais je ne trouve plus ce paramètre dans PyCharm 2017.1.2. Des idées, où ce paramètre est allé?

Je veux avoir la description de type param_type dans la même ligne, mais la manière standard le place dans la ligne suivante.

Answer 1

Il se trouve dans Paramètres -> Outils -> Outils intégrés Python -> Docstrings -> Docstring format.

Si je comprends bien le format que vous êtes après est le NumPy un.

De plus, si vous utilisez Python> = 3.5, vous savez peut-être sur les conseils de type des variables et des paramètres de la fonction, ce qui semble super bien rangé et vous faire économiser de l'espace dans le docstring: https://docs.python.org/3/library/typing.html

SPHINX les soutient avec l'un des:

• https://github.com/agronholm/sphinx-autodoc-typehints
• https://github.com/nicolashainaux/sphinx-autodoc-annotation