Sphinx 文档字符串:指定 class 类型而不是对象?
Sphinx docstring: specify class type instead of object?
在 Sphinx 中,假设您有一个接受一个参数的函数。您的文档字符串可能如下所示:
class A(object):
pass
def funct1(a_object):
"""
:type a_object: A
"""
pass
funct1(A())
但是,如果您传递的不是 class A 的对象,而是 class "A" 本身呢?该文档字符串看起来如何?
class B(object):
pass
def funct2(b_class):
"""
:type b_class: ?????
"""
pass
funct2(B)
我认为这应该适用于类型提示,即使它在技术上不是 100% 准确:
class B(object):
pass
def funct2(b_class):
"""
:type b_class: () -> B
"""
pass
funct2(B)
在 Sphinx 中,假设您有一个接受一个参数的函数。您的文档字符串可能如下所示:
class A(object):
pass
def funct1(a_object):
"""
:type a_object: A
"""
pass
funct1(A())
但是,如果您传递的不是 class A 的对象,而是 class "A" 本身呢?该文档字符串看起来如何?
class B(object):
pass
def funct2(b_class):
"""
:type b_class: ?????
"""
pass
funct2(B)
我认为这应该适用于类型提示,即使它在技术上不是 100% 准确:
class B(object):
pass
def funct2(b_class):
"""
:type b_class: () -> B
"""
pass
funct2(B)