Измените формат reStructuredText в PyCharm для автоматического создания комментариев

В документации JetBrains говорится, что существует два формата для создания reStructuredText комментарии с подсказками:

: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)

Раньше был способ, как вы могли выбрать тот или иной способ создания комментариев, но я больше не могу найти этот параметр в PyCharm 2017.1.2. Есть идеи, куда делся этот параметр?

Я хочу, чтобы описание типа param_type было в той же строке, но стандартный способ помещает его в следующую строку.


person Alexander Pacha    schedule 11.05.2017    source источник
comment
Нашел ли способ поместить тип и параметр в одну строку? Я тоже ищу.   -  person DEADBEEF    schedule 20.02.2018


Ответы (1)


Это в «Настройки» -> «Инструменты» -> «Интегрированные инструменты Python» -> «Строки документации» -> «Формат строки документации».

введите здесь описание изображения

Если я правильно понимаю, вам нужен формат NumPy.

Кроме того, если вы используете Python>=3.5, вы, возможно, уже знаете о подсказках типов в переменных и параметрах функций, которые выглядят очень аккуратно и экономят место в строке документации: https://docs.python.org/3/library/typing.html

И sphinx поддерживает их одним из:

person gozzilli    schedule 29.12.2017