将继承另一个类的类记录在文档中的PEP8约定是什么?

时间:2018-06-25 15:24:58

标签: python pep8 docstring

当我尝试跟随PEP8和doc字符串涉及继承的类时,PEP8的PyCharm / PyCode Check总是警告我继承的参数无引用。删除这些更好吗?我应该在子类的类中完全提到参数吗?

例如

模块1

class Parent:
    """Parent class
    :param plugin: a plugin
    :type plugin: plugin type

    """

    def __init___(self,plugin):
         self.plugin = plugin

模块2

class Child(Parent):
    """
    :param plugin: the plugin from parent class
    """

模块2会警告我有关没有参考的插件。 PEP8的最佳做法?

1 个答案:

答案 0 :(得分:2)

对此没有规范的PEP8答案,因此请关闭。 标准做法是在孩子中不要包含或提及父级的文档字符串。