#python #citations
#python #цитаты
Вопрос:
Как разработчики должны указывать, как пользователи должны ссылаться на пакет, кроме как в документации?
Пакеты R возвращают предпочтительную цитату с помощью citation("pkg")
.
Я могу придумать pkg.CITATION
, pkg.citation
и pkg.__citation__
. Есть ли другие? Если предпочтительного способа нет (что, похоже, имеет место для меня, поскольку я ничего не нашел на python.org ), каковы плюсы и минусы каждого из них?
Комментарии:
1. Я не знаю об этом в Python. Я имею в виду, что есть
__name__
и__doc__
, но они не для такого рода цитирования R.2. Да, в конце концов, это, вероятно, вопрос соглашения.
Ответ №1:
Наконец, я выбрал вариант dunder. Только опция dunder ( __citation__
) дает понять, что это не обычная переменная, необходимая для выполнения.
Да, строки dunder не следует использовать для раздувания, потому что python может использовать их позже. Но если python собирается использовать __citation__
, то это будет для аналогичной цели. Кроме того, я считаю, что относительные затраты выше при использовании других вариантов.