PEP8 约定是什么,用于对继承另一个类的类进行文档串接?



当我尝试遵循PEP8并记录一个涉及继承的类时,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 的最佳实践?

没有规范的 PEP8 答案,所以结束。 标准做法是不在子项中包含或提及父项的文档字符串。

相关内容

最新更新