PyCharmの関数を文書化するための規約は何ですか？

Question

PyCharmが機能を文書化するためのテンプレートを提供します：

def silly_function(a): 
    """ 

    :param a: 
    :return: 
    """ 
    return "Silly" if a else "Function" 

私は、Python docstring conventionに従うことをしようとしているが、何PyCharmは私が:param a:ためと:return:のために置くことを期待していますか？

もし私が良い例を指摘できれば、それも素晴らしいでしょう。

Answer 1

PyCharmのではなく、Pythonの規約です。

aのパラメータ（つまり「10より小さい偶数の数」）が返される値を表している必要があります。