我一直想写这样的文档字符串时遇到这个问题:
def foo(arg):
'''Add ``arg`` to the list of :class:`foo.bar.baz.Argument`s.'''
pass
但是,这不起作用,Sphinx会警告
py:class reference target not found: foo.bar.baz.Argument`s
,因此在结束点后将s
视为类名的一部分。例如,这不会发生标点符号,例如点.
。
除了在类名和Plural-s(看起来很疯狂)之间添加一个空格外,对此有什么办法要做?
答案 0 :(得分:3)
您应该可以使用backslash-escaped whitespace。
def foo(arg):
'''Add ``arg`` to the list of :class:`foo.bar.baz.Argument`\ s.'''
pass