python / python/python-docs-ja

Warnings during documentation build

Offen
#1 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Makefile
Sterne
75
Forks
38
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit den Übersetzungs-Build-Protokollen für Python 3.6 und vergleichen Sie die betroffenen Einträge in c-api/arg.po und c-api/init.po mit ihren englischen Meldungen. Überprüfen Sie die Warnungen unter Doc/library/, einschließlich doctest.rst, exceptions.rst, functions.rst, gettext.rst, grp.rst und gzip.rst. Bestimmen Sie, welche Warnungen auf Fehler im Übersetzungs-Markup und welche auf beabsichtigte Unterschiede hinweisen, und führen Sie anschließend den Build erneut aus, um zu überprüfen, dass die betroffenen Warnungen behoben wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation, localization
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.