Tanto numpy.conj
como numpy.conjugate
existen y, de hecho, los documentos para conj
muestran ejemplos que usan conjugate
:
https://docs.scipy.org/doc/numpy-1.12.0/reference/generated/numpy.conj.html
Además, la página de numpy.conjugate no existe. Sería bueno hacer esto más consistente, por ejemplo, cambiar los ejemplos en la página conj
para usar conjugate
, o agregar una nota a los documentos de conj
que pueden ser usado.
Mientras estamos en eso, probablemente sea bueno asegurarse de que notemos que, de hecho, son solo alias:
In [2]: np.conj is np.conjugate
Out[2]: True
Véase también np.max
y np.amax
, por lo que creo que deberíamos animar al primero
Hola. Me gustaría retomar esto y quería proponer un flujo de trabajo.
También podemos crear una página separada para np.conjugate
e incluir ejemplos relevantes en esa página. Además, cambie los ejemplos en la página np.conj
para usar conj
y mencione en ambas páginas que son alias entre sí y proporcione una referencia en la sección See Also
.
Esto es para mantener la coherencia con la documentación de los alias como se hace, por ejemplo, con la función np.random.random
. Por favor, hágame saber si puedo continuar con este flujo. ¡Gracias!
@kritisingh1 : dado que las dos funciones son iguales, np.conj is np.conjugate
, solo necesita actualizar la única cadena de documentación que comparten. Creo que usaría np.conjugate
todas partes, ya que generalmente es bueno no usar abreviaturas (y conj
se crea explícitamente como un alias en ufuncmodule.c
). Además, eso necesita el menor cambio: la cadena de documentación podría mencionar que np.conj
es un alias. Para ahorrarte la búsqueda: las cadenas de documentación están en numpy/core/code_generators/ufunc_docstrings.py
Luego, el siguiente paso es asegurarse de que se generen páginas de documentación para ambas funciones. Aquí, debe ajustar tanto docs/source/reference/routines.umath.src
como docs/source/reference/ufuncs.rst
.
Mientras lo hace, ¿sería posible también actualizar la cadena de documentación de remainder
para mencionar que mod
es un alias? Además, no estoy muy seguro de que la lista en ufuncs.rst
esté actualizada. Podría ser bueno comparar con lo que realmente exponemos:
import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
Comentario más útil
Mientras estamos en eso, probablemente sea bueno asegurarse de que notemos que, de hecho, son solo alias: