Модифицированные строки документации в стиле sphinx в vscode

Все, я пробую это как в VSCode, так и в Pycharm. По сути, я хочу изменить стиль моей автоматически сгенерированной строки документации. В VSCode я использую расширение «Генератор строк документации Python». В настоящее время установка его на sphinx генерирует что-то вроде этого:

def test(a, b):
    """
    :param a: 
    :type a:
    :param b:
    :type b:
    :return:
    :rtype:
    """

Вместо этого я хотел бы, чтобы это произошло так:

def test(a, b):
    """
    :param type a: 
    :param type b:
    :return:
    :rtype:
    """

Может ли кто-нибудь помочь мне достичь этого в Pycharm или VSCode?


python-3.x pycharm vscode-settings docstring
person UGuntupalli    schedule 11.05.2020    source источник
comment
BUMP .. Ищу помощь по этому поводу   -  person UGuntupalli    schedule 15.05.2020

Ответы (1)


arrow_upward
0
arrow_downward

Похоже, вы можете указать собственный шаблон из документации

The extension uses the mustache.js templating engine. To use a custom template create a .mustache file and specify its path using the customTemplatePath configuration. View the included google docstring template for a usage example. The following tags are available for use in custom templates.
Variables

{{name}}                        - name of the function
{{summaryPlaceholder}}          - [summary] placeholder
{{extendedSummaryPlaceholder}}  - [extended_summary] placeholder

Sections

{{#args}}                       - iterate over function arguments
    {{var}}                     - variable name
    {{typePlaceholder}}         - [type] or guessed type  placeholder
    {{descriptionPlaceholder}}  - [description] placeholder
{{/args}}
person mmann1123    schedule 01.10.2020