为新软件编写pydoc

时间:2018-11-05 04:40:29

标签: python pydoc

Python中的此doc格式是什么,这是编写python doc的推荐方法吗?有写文档约定的官方指南吗?

  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等类型的对象。

0 个答案:

没有答案