如何解决Intersphinx 文档字符串可读性
Intersphinx 是一个非常好的工具,用于将交叉引用放入包文档中。然而,一个问题是,当在终端中使用 help(function)
或在 jupyter-notebook 中使用 function?
阅读时,这些交叉引用的写入方式会降低文档字符串的易读性。
考虑以下示例:
def time2int(ds: Series) -> Series:
"""Convert :class:`~pandas.Series` encoded as
:class:`~numpy.datetime64` or :class:`~numpy.timedelta64` to :class:`int`
Parameters
----------
ds: Series
Returns
-------
Series
"""
请注意,由于类型别名,参数和返回类型实际上不需要 :class:`~pandas.
前缀:
napoleon_type_aliases = {
"Series" : "~pandas.Series"
}
对于文档字符串的函数描述部分,是否有一种简单的方法可以实现相同的目标?理想情况下,我希望有一种方法可以定义一个宏,以尽可能减少文档字符串中的噪音(= 非内容字符)。如果可以定义宏/交叉引用,以便我们可以编写 Series_
或 :Series:
或类似的东西而不是 :class:`~pandas.Series`
并获得相同的格式,那将是一个巨大的改进。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。