Search code examples
python-3.xpycharmrestructuredtext

Can I avoid variable type field in Pycharm Docstrings?


I am using Pycharm Docstrings reStructuredText to document my code, and I was wondering whether the variable type in the function documentation can be omitted automatically, let's say I have this function

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

Automatic documentation will produce

 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

However, I am looking for having something akin to below

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

Thus, I may keep consistency with prior code. Is that possible?


Solution

  • By digging a bit, and thanks to this other post I found the solution, which is

    Settings -> Editor -> General -> Smart Keys -> Python -> Untick Insert type placeholders in the documentation stub

    Cheers