python / python/python-docs-ja

Warnings during documentation build

Open
#1 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
75
Forks
38
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Python 3.6 translation build logs and compare the affected entries in c-api/arg.po and c-api/init.po with their English messages. Review the warnings under Doc/library/, including doctest.rst, exceptions.rst, functions.rst, gettext.rst, grp.rst, and gzip.rst. Determine which warnings indicate translation markup errors versus intentional differences, then rebuild to verify the affected warnings are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, localization
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.