Можно ли избежать поля типа переменной в Pycharm Docstrings? - PullRequest
1 голос
/ 25 марта 2020

Я использую Pycharm Docstrings reStructuredText для документирования моего кода, и мне было интересно, можно ли автоматически исключить тип переменной в документации функции, скажем, у меня есть эта функция

def unsignedToSigned(inputNumber,numberType):
    if(inputNumber >= 2**(numberType-1)):
        signedNumber = inputNumber - 2**numberType
    else:
        signedNumber = inputNumber
    return signedNumber

Документация Automati c будет производить

 def unsignedToSigned(inputNumber,numberType):
        '''  
        :param inputNumber: 
        :type inputNumber: 
        :param numberType: 
        :type numberType: 
        :return: 
        :rtype: 
        '''
        if(inputNumber >= 2**(numberType-1)):
            signedNumber = inputNumber - 2**numberType
        else:
            signedNumber = inputNumber
        return signedNumber

Однако я ищу что-то похожее на значение ниже

 def unsignedToSigned(inputNumber,numberType):
        '''  
        :param inputNumber: 
        :param numberType: 
        :return: 
        '''
        if(inputNumber >= 2**(numberType-1)):
            signedNumber = inputNumber - 2**numberType
        else:
            signedNumber = inputNumber
        return signedNumber

Таким образом, я могу сохранить последовательность с предыдущим кодом. Это возможно?

1 Ответ

0 голосов
/ 25 марта 2020

Копая немного, и благодаря этому другому посту я нашел решение, которое

Настройки -> Редактор -> Общие -> Умные ключи -> Python -> Снять галочку Вставить заполнители типа в заглушку документации

Приветствия

...