numpy.conj
et numpy.conjugate
existent, et en fait les docs pour conj
montrent des exemples qui utilisent conjugate
:
https://docs.scipy.org/doc/numpy-1.12.0/reference/generated/numpy.conj.html
De plus, la page pour numpy.conjugate n'existe pas. Ce serait bien de rendre cela plus cohérent, par exemple, modifiez les exemples dans la page conj
pour utiliser conjugate
, ou ajoutez une note aux documents conj
qui peuvent être utilisé.
Pendant que nous y sommes, il est probablement bon de s'assurer que nous notons qu'il ne s'agit en fait que d'alias :
In [2]: np.conj is np.conjugate
Out[2]: True
Voir aussi np.max
et np.amax
, pour lesquels je pense que nous devrions encourager le premier
Salut. Je voudrais reprendre cela et je voulais proposer un workflow.
Nous pouvons également créer une page distincte pour np.conjugate
et inclure des exemples pertinents dans cette page. Modifiez également les exemples de la page np.conj
pour utiliser conj
et mentionnez dans les deux pages qu'ils sont des alias l'un de l'autre et fournissez une référence dans la section See Also
.
Il s'agit de maintenir la cohérence avec la documentation des alias, comme c'est le cas pour la fonction np.random.random
. Veuillez me faire savoir si je peux continuer avec ce flux. Merci!
@ kritisingh1 - puisque les deux fonctions sont identiques - np.conj is np.conjugate
- vous n'avez qu'à mettre à jour la seule docstring qu'elles partagent. Je pense que j'utiliserais np.conjugate
partout, car il est généralement bon de ne pas utiliser d'abréviations (et conj
est créé explicitement comme alias dans ufuncmodule.c
). De plus, cela nécessite le moins de changement : la docstring pourrait simplement mentionner que np.conj
est un alias. Pour vous éviter de chercher : les docstrings sont dans numpy/core/code_generators/ufunc_docstrings.py
Ensuite, l'étape suivante consiste à s'assurer que les pages de documentation pour les deux fonctions sont générées. Ici, vous devez ajuster à la fois docs/source/reference/routines.umath.src
et docs/source/reference/ufuncs.rst
.
Pendant que vous y êtes, serait-il également possible de mettre à jour la docstring de remainder
pour mentionner mod
est un alias ? De plus, je ne suis pas tout à fait sûr que la liste dans ufuncs.rst
soit en fait à jour. Il serait peut-être bon de comparer avec ce que nous exposons réellement :
import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
Commentaire le plus utile
Pendant que nous y sommes, il est probablement bon de s'assurer que nous notons qu'il ne s'agit en fait que d'alias :