Numpy: Document ndindex (forme)

Créé le 3 juil. 2020 · 3Commentaires · Source: numpy/numpy

Cette utilisation de ndindex :

>>> list(np.ndindex((3,2)))
[(0, 0), (0, 1), (1, 0), (1, 1), (2, 0), (2, 1)]

semble fonctionner avec

>>> np.__version__
'1.18.4'

mais ce n'est pas documenté . Cette utilisation est-elle censée être autorisée ? (J'aimerais que ce soit le cas, car si shape == 5 alors np.index(shape) fonctionne alors que np.ndindex(*shape) ne fonctionne pas.) Si c'est le cas, pourrait-il être ajouté à la documentation ?

04 - Documentation

Source

inducer

Commentaire le plus utile

De plus, la liste des types dans la section Paramètres est incorrecte : les tuples et la liste d'entiers sont autorisés.

Cela a été corrigé.

La signature de la docstring np.ndindex est incohérente avec la liste des paramètres

Je ferai un PR pour ça :)

rohitsanj le 12 juil. 2020

👍2

Tous les 3 commentaires

Nous voudrons peut-être faire de cette version la version documentée préférée, et mentionner brièvement l'autre option également. Dans la plupart des cas (par exemple aussi arr.reshape() où nous autorisons les deux, nous préférons la version tuple dans la documentation).

seberg le 5 juil. 2020

👍2

Juste pour clarifier un peu cela - je pense qu'il y a deux choses qui rendent la docstring np.ndindex déroutante :

La signature de la docstring np.ndindex est incohérente avec la liste des paramètres
De plus, la liste des types dans la section Paramètres est incorrecte : les tuples et la liste d'entiers sont autorisés.