numpy.conj
和numpy.conjugate
都存在,实际上conj
的文档显示了使用conjugate
的示例:
https://docs.scipy.org/doc/numpy-1.12.0/reference/generated/numpy.conj.html
此外, numpy.conjugate 的页面不存在。 让它更加一致会很好,例如将conj
页面中的示例更改为使用conjugate
,或者在conj
文档中添加一个注释,可以是用过的。
当我们这样做时,最好确保我们注意到它们实际上只是别名:
In [2]: np.conj is np.conjugate
Out[2]: True
另见np.max
和np.amax
,我觉得我们应该鼓励前者
你好。 我想接受这个并想提出一个工作流程。
我们也可以为np.conjugate
创建一个单独的页面,并在该页面中包含相关示例。 此外,将np.conj
页面中的示例更改为使用conj
并在两个页面中提及它们是彼此的别名,并在See Also
部分提供参考。
这是为了保持与别名文档的一致性,例如np.random.random
函数请让我知道我是否可以继续此流程。 谢谢!
@kritisingh1 - 因为这两个函数是相同的 - np.conj is np.conjugate
- 你只需要更新他们共享的一个文档字符串。 我想我会在任何地方使用np.conjugate
,因为通常最好不要使用缩写(并且conj
是在ufuncmodule.c
明确创建的别名)。 此外,这恰好需要最少的更改:文档字符串可以只提到np.conj
是一个别名。 为了节省您的搜索:文档字符串在numpy/core/code_generators/ufunc_docstrings.py
然后,下一步是确保生成两个函数的文档页面。 在这里,您必须同时调整docs/source/reference/routines.umath.src
和docs/source/reference/ufuncs.rst
。
当您使用它时,是否也可以更新remainder
的文档字符串以提及mod
是别名? 另外,我不太确定ufuncs.rst
中的列表实际上是最新的。 与我们实际公开的内容进行比较可能会更好:
import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
最有用的评论
当我们这样做时,最好确保我们注意到它们实际上只是别名: