PyCharm'ın docstring şablonunun kullanımı nedir? Bunu nasıl verimli kullanırım?

Question

PyCharm, Python IDE, docstring'i yazmaya başladığımda docstring için bir şablon oluşturur. Bu basit bir işlev için oluşturulan şablon.

def add_them(x, y): 
    """ 

    :param x: 
    :param y: 
    :return: 
    """ 
    z = x + y 
    return z 

ben o Python'un resmi docstringe conventions benzer bir şey yok.

Bu şablonda readthedocs gibi herhangi bir belge üreticisi ile herhangi bir kullanım var mı?

Birisi nasıl etkili bir şekilde kullanıyor?

Şablonu doldurmanın uygun yolu nedir?

Teşekkürler.

Answer 1

HTML ve PDF belgelerini oluşturmak için sphinx-apidoc ile kullanıyoruz.

def add_pdr(process, userid, log): 
    """ Create and perform the target account operation PDR 

    If the function/method is complex, I'd put a short one-line 
    summary in the first line above, and a more detailed explanation 
    here. 

    :param dict process: dict of process details 
    :param str userid: userid to perform actions on 
    :param obj log: log object to perform logging to 

    :raises KeyError: if the userid doesn't exist 
    :raises APIError: if process dict is invalid 

    :return: True on success, False upon failure 

    """