python / python/python-docs-ja
Warnings during documentation build
まだ誰も着手していません。
- 主要言語
- 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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Python 3.6 の翻訳ビルドログから始め、c-api/arg.po と c-api/init.po の影響を受けるエントリを英語のメッセージと比較します。doctest.rst、exceptions.rst、functions.rst、gettext.rst、grp.rst、gzip.rst を含む Doc/library/ 配下の警告を確認します。どの警告が翻訳マークアップのエラーを示し、どの警告が意図的な差異を示しているのかを判断し、その後再ビルドして、影響を受ける警告が対処されていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation, localization
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100