如何解决Sphinx:共享函数文档字符串
我想在多个类中重用用于同一函数的文档字符串。
例如
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 个不同的参数,能够使用相同的文档字符串将确保一致性。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。