Google格式的功能摘要未显示在PyCharm的快速文档窗口中

时间:2019-03-25 22:24:15

标签: python pycharm jetbrains-ide docstring

PyCharm 2018.3可以在“文件”>“设置”>“工具”>“ Python集成工具”>“文档字符串格式”下更改文档字符串格式

选择“ Google”后,我编写如下代码:

def my_func(a, b):
    """
    Do something with a and b

    Args:
        a: first arg
        b: second arg

    Returns:
        something

    """
    pass

除了要在快速文档窗口中显示的参数外,我还想要摘要,即“用a和b做某事”,但是我得到的只是这个

enter image description here

我做错了还是PyCharm中的错误?

1 个答案:

答案 0 :(得分:0)

使用Pycharm Professional 2018.3.5,并复制您的确切示例,我无法重现该错误。 (我将这个回答作为答案,因为它可以使您的研究更接近答案。)

这是我从快速文档中得到的结果:

def my_func(a: Any,
            b: Any) -> None
Do something with a and b
Params:
a – first arg
b – second arg
Returns:
something