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-2つの関数は同じであるため- np.conj is np.conjugate
-共有する1つのdocstringを更新するだけで済みます。 略語を使用しないのが一般的に良いので、どこでもnp.conjugate
を使用すると思います(そしてconj
はufuncmodule.c
のエイリアスとして明示的に作成されます)。 また、それはたまたま最小限の変更で済みます。docstringは、 np.conj
がエイリアスであるとだけ言及することができます。 検索を節約するために:docstringsはnumpy/core/code_generators/ufunc_docstrings.py
にあります
次に、次のステップは、両方の機能のドキュメントページが生成されるようにすることです。 ここでは、 docs/source/reference/routines.umath.src
とdocs/source/reference/ufuncs.rst
の両方を調整する必要があります。
その間、 remainder
のdocstringを更新して、 mod
がエイリアスであることを示すこともできますか? また、 ufuncs.rst
のリストが実際に最新であるかどうかはよくわかりません。 私たちが実際に公開しているものと比較するのは良いかもしれません:
import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
最も参考になるコメント
私たちがそれに取り組んでいる間、それらが実際には単なるエイリアスであることに注意するのはおそらく良いことです: