什么是 PEP8 约定来记录继承另一个 class 的 Class?
What is PEP8 convention to docstring a Class that inherits another class?
当我尝试遵循 PEP8 和文档字符串 a class 涉及继承时,PyCharm/PyCode 检查 PEP8 总是给我一个警告,即继承的参数没有引用。只删除这些更好吗?我是否应该在子 class 的 class 中提及参数?
例如
模块 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 答案,因此关闭。
标准做法是不在子项中包含或提及父项的文档字符串。
当我尝试遵循 PEP8 和文档字符串 a class 涉及继承时,PyCharm/PyCode 检查 PEP8 总是给我一个警告,即继承的参数没有引用。只删除这些更好吗?我是否应该在子 class 的 class 中提及参数?
例如
模块 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 答案,因此关闭。 标准做法是不在子项中包含或提及父项的文档字符串。