И 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 - поскольку две функции одинаковы - np.conj is np.conjugate
- вам нужно обновить только одну строку документации, которую они разделяют. Я думаю, что везде использовал бы np.conjugate
, так как вообще хорошо не использовать аббревиатуры (а conj
создается явно как псевдоним в ufuncmodule.c
). Кроме того, это требует наименьших изменений: в строке документации можно просто упомянуть, что np.conj
является псевдонимом. Чтобы избавить вас от поиска: строки документации находятся в numpy/core/code_generators/ufunc_docstrings.py
Затем следующим шагом будет обеспечение создания страниц документации для обеих функций. Здесь вам нужно настроить как docs/source/reference/routines.umath.src
и docs/source/reference/ufuncs.rst
.
Пока вы этим занимаетесь, можно ли также обновить строку документации remainder
чтобы указать, что mod
является псевдонимом? Кроме того, я не совсем уверен, что список в ufuncs.rst
действительно актуален. Было бы неплохо сравнить с тем, что мы на самом деле выставляем:
import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
Самый полезный комментарий
Пока мы на этом, вероятно, хорошо убедиться, что мы отмечаем, что они на самом деле просто псевдонимы: