0

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

是否可以将“np.ndarray”用作 Google 样式的文档字符串中的一种类型,或者必须完整地写出“numpy.ndarray”?

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

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

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

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

4

0 回答 0