Что такое соглашение PEP8 для документирования класса, который наследует другой класс? - PullRequest
0 голосов
/ 25 июня 2018

Когда я пытаюсь следовать PEP8 и документировать строку класса, который включает наследование, проверка PyCharm / PyCode для PEP8 всегда выдает мне предупреждение о том, что унаследованные параметры не имеют ссылки.Лучше просто удалить их?Стоит ли вообще упоминать параметры в подклассах класса?

Например,

МОДУЛЬ 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 голосов
/ 28 июня 2018

Нет канонического ответа PEP8 для этого, так что закрытие.Стандартная практика - не включать или не указывать строку документа родителя в дочернем элементе.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...