python/python-docs-zh-cn

[Typo]: doctest 文档中的数处标记错误

muziing opened this issue · 1 comments

Python Version

似乎是许多版本的共性问题,以3.11为例。

Docs Page

https://docs.python.org/zh-cn/3.11/library/doctest.html

Original Translation

我在阅读 doctest --- 测试交互性的Python示例 的中文翻译文档时发现了几处可能因为 rst 标记语法解析错误而导致的问题,整理提交到这里。希望能对简中版文档的精益求精有所帮助,感谢翻译者们的贡献。

  • 文档首行的 ** 源代码 **
  • 简单用法小节中的 其中*N*是失败的例子的数量,应为斜体的 N,不过英文原文就有些奇怪
  • 检查文本文件中的例子这可以用 testfile() 函数来完成;: 多了一个分号 ;
  • doctest.DocFileSuite() 函数文档中 如果*module_relative*是 True (默认值)
  • find 方法 如果没有指定*name*,

Original Docs Paragraph

No response

Suggested Fix

Fix

可能因为 rst 标记语法解析错误而导致的问题

是的。这些错误都是因为 rst 语法的问题。当时翻译没有留出对应的空格,因此没有正常解析。

我已经在Transifex上修订了3.8及以上版本的文档。3.7及以下版本因为已经存档无法修改。

似乎是许多版本的共性问题

大部分译文在后续的版本更新中都会延续先前版本的译文。因为最初版本的译文有这些讹误,因此袭承下来了。