ändern reStructuredText Format in PyCharm für automatisch generierte Kommentare

Question

Die Dokumentation von JetBrains sagt, dass es zwei Formate für reStructuredText Schaffung 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) 

Früher gab es einen Weg zu geben, wie Sie könnte man wählen oder die Anders ausgedrückt, wie Kommentare generiert wurden, aber ich kann diese Einstellung in PyCharm 2017.1.2 nicht mehr finden. Irgendwelche Ideen, wo diese Einstellung ging?

Ich möchte Typ Beschreibung param_type in der gleichen Zeile haben, aber der Standard Weg bringt es in die nächste Zeile.

Answer 1

Es ist in Einstellungen -> Tools -> Integrierte Python-Tools -> Docstrings -> Docstring-Format.

Wenn ich das richtig verstanden, das Format sind Sie nach ist die NumPy ein.

Auch, wenn Sie Python verwenden> = 3,5, können Sie bereits über Typ Hinweise in Variablen und Parameter der Funktion kennen, die super ordentlich aussieht und Sie Platz im docstring sparen: https://docs.python.org/3/library/typing.html

Und Sphinx unterstützt sie mit einem von:

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