python / python/python-docs-ja

Warnings during documentation build

未关闭
#1 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Makefile
星标
75
派生
38
PR 合并指标
30 天内没有已合并 PR

描述

While building the translation for 3.6, I got some inconsistent term references in translated message and some Inline interpreted text or phrase reference start-string without end-string..

Typically in https://github.com/python/python-docs-ja/blob/3.6/c-api/arg.po#L633:

msgid "Convert a Python integer to a C :c:type:`long long`."
msgstr "PythonのintをC :c:type:`long long`へ変換する。"

It looks like the rst parser does not like the へ to be glued to the backtick. I hoever don't know Japanese and can't tell if a space is acceptable or not here.

Some "inconsistend term references" looks to be legitimate (using a term reference when the term is used in the english version without reference) but some may not be, like: "https://github.com/python/python-docs-ja/blob/3.6/c-api/init.po#L1153 the translation speak about PyEval_RestoreThread but the english paragraph does not. Can't tell if it's an issue or deliberate though.

Here is a short extraction from the docs.python.org logs, tell me if you want more:

/srv/docsbuild/python36/Doc/library/doctest.rst:1386: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/doctest.rst:1409: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/doctest.rst:1546: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/doctest.rst:1556: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/doctest.rst:1698: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/doctest.rst:1794: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/email.header.rst:110: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/email.util.rst:116: WARNING: inconsistent footnote references in translated message
/srv/docsbuild/python36/Doc/library/exceptions.rst:460: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/srv/docsbuild/python36/Doc/library/exceptions.rst:460: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/srv/docsbuild/python36/Doc/library/exceptions.rst:460: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/exceptions.rst:465: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/functions.rst:1172: WARNING: Inline emphasis start-string without end-string.
/srv/docsbuild/python36/Doc/library/functions.rst:936: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/functions.rst:1143: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/functions.rst:1172: WARNING: Inline emphasis start-string without end-string.
/srv/docsbuild/python36/Doc/library/functions.rst:1533: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/gettext.rst:151: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/gettext.rst:316: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/gettext.rst:517: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/grp.rst:46: WARNING: inconsistent term references in translated message
/srv/docsbuild/python36/Doc/library/gzip.rst:64: WARNING: inconsistent term references in translated message

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 Python 3.6 的翻译构建日志开始,将 c-api/arg.po 和 c-api/init.po 中受影响的条目与其英文消息进行比较。检查 Doc/library/ 下的警告,包括 doctest.rst、exceptions.rst、functions.rst、gettext.rst、grp.rst 和 gzip.rst。确定哪些警告表示翻译标记错误,哪些表示有意的差异,然后重新构建以验证相关警告已得到处理。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation, localization
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。