向 python 包添加引用建议的首选方法是什么?
What is the preferred way to a add a citation suggestion to python packages?
开发人员应该如何指示用户应该如何引用包,而不是在文档上?
R包return首选引用使用citation("pkg")
.
我能想到pkg.CITATION
、pkg.citation
和pkg.__citation__
。还有其他人吗?如果没有首选方法(对我来说似乎是这种情况,因为我在 python.org 上没有找到任何东西),每种方法的优缺点是什么?
最后我选择了 dunder 选项。只有 dunder 选项 (__citation__
) 清楚表明,这不是运行时所需的普通变量。
是的,dunder 字符串不应该被用来膨胀,因为 python 以后可能会用到它们。但是如果 python 打算使用 __citation__
,那么它也会用于类似的目的。另外,我认为其他选项的相对成本更高。
开发人员应该如何指示用户应该如何引用包,而不是在文档上?
R包return首选引用使用citation("pkg")
.
我能想到pkg.CITATION
、pkg.citation
和pkg.__citation__
。还有其他人吗?如果没有首选方法(对我来说似乎是这种情况,因为我在 python.org 上没有找到任何东西),每种方法的优缺点是什么?
最后我选择了 dunder 选项。只有 dunder 选项 (__citation__
) 清楚表明,这不是运行时所需的普通变量。
是的,dunder 字符串不应该被用来膨胀,因为 python 以后可能会用到它们。但是如果 python 打算使用 __citation__
,那么它也会用于类似的目的。另外,我认为其他选项的相对成本更高。