Baik numpy.conj
dan numpy.conjugate
ada, dan sebenarnya dokumen untuk conj
menunjukkan contoh yang menggunakan conjugate
:
https://docs.scipy.org/doc/numpy-1.12.0/reference/generated/numpy.conj.html
Selain itu, halaman untuk numpy.conjugate tidak ada. Akan lebih baik untuk membuat ini lebih konsisten, misalnya mengubah contoh untuk halaman conj
menggunakan conjugate
, atau menambahkan catatan ke conj
docs yang juga dapat digunakan.
Sementara kami melakukannya, mungkin baik untuk memastikan kami mencatat bahwa mereka, pada kenyataannya, hanya alias:
In [2]: np.conj is np.conjugate
Out[2]: True
Lihat juga np.max
dan np.amax
, yang menurut saya kita harus mendorong yang pertama
Hai. Saya ingin mengambil ini dan ingin mengusulkan alur kerja.
Kami juga dapat membuat halaman terpisah untuk np.conjugate
dan menyertakan contoh yang relevan di halaman tersebut. Juga, ubah contoh di halaman np.conj
untuk menggunakan conj
dan sebutkan di kedua halaman bahwa keduanya adalah alias satu sama lain dan berikan referensi di bagian See Also
.
Ini untuk menjaga konsistensi dengan dokumentasi alias seperti yang dilakukan dengan misalnya, fungsi np.random.random
Tolong beri tahu saya jika saya dapat melanjutkan alur ini. Terima kasih!
@kritisingh1 - karena kedua fungsinya sama -- np.conj is np.conjugate
-- Anda hanya perlu memperbarui satu docstring yang mereka bagikan. Saya pikir saya akan menggunakan np.conjugate
di mana-mana, karena umumnya baik untuk tidak menggunakan singkatan (dan conj
dibuat secara eksplisit sebagai alias dalam ufuncmodule.c
). Juga, itu membutuhkan sedikit perubahan: docstring bisa saja menyebutkan bahwa np.conj
adalah alias. Untuk menghemat pencarian Anda: docstrings ada di numpy/core/code_generators/ufunc_docstrings.py
Kemudian, langkah selanjutnya adalah memastikan bahwa halaman dokumentasi untuk kedua fungsi dibuat. Di sini, Anda harus menyesuaikan docs/source/reference/routines.umath.src
dan docs/source/reference/ufuncs.rst
.
Saat Anda melakukannya, apakah mungkin juga memperbarui docstring remainder
untuk menyebutkan mod
adalah alias? Juga, saya tidak yakin daftar di ufuncs.rst
sebenarnya terbaru. Mungkin bagus untuk membandingkan dengan apa yang sebenarnya kami paparkan:
import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
Komentar yang paling membantu
Sementara kami melakukannya, mungkin baik untuk memastikan kami mencatat bahwa mereka, pada kenyataannya, hanya alias: