【问题标题】:How do I convert Python docstrings to a different style?如何将 Python 文档字符串转换为不同的样式?
【发布时间】:2019-07-22 10:18:43
【问题描述】:

我正在开发一个使用Google style Python 文档字符串的代码库,我想将它们自动 转换为numpy style

是否有自动执行此操作的工具?

快速的 Google 搜索显示 pyment,但我不确定这是否合适。

【问题讨论】:

  • 看来你已经用 pyment 回答了你自己的问题。你试过了吗?它没有做你想做的事吗? github.com/dadadel/pyment/blob/master/doc/sphinx/source/…
  • 我想知道是否有人有在大型代码库上使用它的经验。您对结果满意吗?
  • 但是为什么不直接克隆代码库,使用它,然后自己看看呢?

标签: python converters docstring


【解决方案1】:

pyment 绝对看起来像这项工作的工具,因为它声明它可以在两个方向上在 numpydoc 和 google 文档字符串之间进行转换。

目前,输入/输出中的托管样式是 javadoc、reST 的一种变体(Sphinx 使用的重新结构化文本)、numpydoc、google 文档字符串、组(其他分组样式)。

【讨论】:

  • @SewerynNiemiec 现在 Pyment 支持类型提示(至少在 v0.4.0 版本中,很快在 Pypi 上可用)
猜你喜欢
  • 1970-01-01
  • 2011-01-15
  • 1970-01-01
  • 1970-01-01
  • 2014-03-12
  • 1970-01-01
  • 2010-11-26
  • 2010-09-22
  • 2015-11-16
相关资源
最近更新 更多