Python 在docstring中放置链接可以吗?

Python 在docstring中放置链接可以吗?,python,docstring,Python,Docstring,例如,假设我正在基于一篇论文编写一个函数。可以在文档字符串中添加指向该文件的链接吗?或者这被认为是糟糕的编码?我可以想象,由于链接可能会断开,Python社区会对此表示不满。如果这是一篇科学论文,您还可以添加DOIDocstring来提供信息。有什么更好的方式提供信息?请记住,url在将来可能并不总是实时的。所以提供更多的信息而不仅仅是链接。我一直认为提供更多的信息比提供更少的信息要好,所以为什么不呢?如果这是一篇科学论文,你也可以添加DOIDocstring来提供信息。有什么更好的方式提供信息

例如,假设我正在基于一篇论文编写一个函数。可以在文档字符串中添加指向该文件的链接吗?或者这被认为是糟糕的编码?我可以想象,由于链接可能会断开,Python社区会对此表示不满。

如果这是一篇科学论文,您还可以添加DOIDocstring来提供信息。有什么更好的方式提供信息?请记住,url在将来可能并不总是实时的。所以提供更多的信息而不仅仅是链接。我一直认为提供更多的信息比提供更少的信息要好,所以为什么不呢?如果这是一篇科学论文,你也可以添加DOIDocstring来提供信息。有什么更好的方式提供信息?请记住,url在将来可能并不总是实时的。所以,提供更多的信息而不仅仅是链接。我一直认为提供更多的信息比提供更少的信息要好,为什么不呢?