您是否必须完整地输入 numpy.ndarray 以获得 Google 风格的文档字符串中的类型提示,或者您可以只输入 np.ndarray?

问题描述

我一直在阅读 this 指南,以编写带有 numpy ndarray 类型提示的 Google 风格和 Numpy 风格的文档字符串。在 Numpy 风格的文档字符串示例中,类型提示缩写为“np.ndarray”。但是,在相应的 Google 样式示例中,类型写为“numpy.ndarray”。

是否可以在 Google 风格的文档字符串中使用“np.ndarray”作为类型,还是必须完整地写出“numpy.ndarray”?

我找不到任何其他在 Google 样式的文档字符串中使用 numpy 类型的示例,但我确实看到了一个完整写出“pandas.dataframe”的示例。

如果可以同时使用两者,根据 Google 风格的指南,哪个是正确的?

我在 sphinx 中使用拿破仑扩展来生成自动文档。

另外,我不确定在上面的正确上下文中是否使用了“类型提示”。 python 文档字符串中的类型规范是否称为“类型提示”,还是仅用于 Python 语言本身中的实际类型提示名称

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)