Написание pydoc для нового программного обеспечения - PullRequest
0 голосов
/ 05 ноября 2018

Что это за формат документа в Python, это рекомендуемый способ написания документа Python? Есть ли какое-нибудь официальное руководство по написанию документов?

  def add(self, val: int) -> None:
        """
        Add value to the heap.

        :param val: Value to add.
        """
        self.array.append(val)
        self._heapify_up(len(self.array) - 1)

Например, я не могу указать, что этот метод вызывает исключение или этот метод возвращает некоторый объект типа x и т. Д.

...