python-3.x - Sphinx：共享函数 Docstring

Question

我想重用一个用于跨多个类的相同函数的文档字符串。

例如

class square:
     def getArea(L,W):
     """ [description]
     L (int) ... 
     W (int) ... 

     return (int) area of shape
     """
     return L*W

 class rectangle:
     def getArea(L,W):
     """ use docstring from above"""
     return L*W

有没有办法在多个函数中使用相同的文档字符串？这是一个简单的例子，但有些函数有 10 个不同的参数，并且能够使用相同的文档字符串将确保一致性。

标签： python-3.xpython-sphinxdocstring