Skip to content

The whitespaces in the Doc/tools/templates/dummy.html make the translation process harder #113637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
egeakman opened this issue Jan 1, 2024 · 0 comments
Labels
3.11 only security fixes 3.12 only security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir

Comments

@egeakman
Copy link
Contributor

egeakman commented Jan 1, 2024

These whitespaces in the dummy.html become an issue when it comes to translating them.

  • If the translator forgets to add a leading or a trailing space, it mostly results in phrases being concatenated without spaces in the HTML.
  • Also linters like sphinx-lint complain a lot about these whitespaces.
  • And some translation file editors (po editors) tend to trim these whitespaces even if the translator did not forget to add them.

Here are some examples from the Turkish translation (scenario of a translator who forgot to add an extra space at the end):

image

image

How it looks in the English Doc (no problems):

image

We could remove the trailing whitespace from "Part of the" and insert a leading whitespace to "Stable ABI", but that would only please the linters. So, I propose removing all the whitespaces (leading and trailing) in the template file and let c_annotations.py to handle the spacing.

These strings about the API and the ABI were made translatable in #107680, which also introduced the whitespaces.

Linked PRs

@egeakman egeakman added the docs Documentation in the Doc dir label Jan 1, 2024
@hugovk hugovk added 3.11 only security fixes 3.12 only security fixes 3.13 bugs and security fixes labels Jan 2, 2024
hugovk pushed a commit that referenced this issue Jan 3, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jan 3, 2024
…d/Unstable API & Stable ABI translation strings (pythonGH-113638)

(cherry picked from commit ea978c6)

Co-authored-by: Ege Akman <egeakmanegeakman@hotmail.com>
egeakman added a commit to egeakman/cpython that referenced this issue Jan 3, 2024
… Limited/Unstable API & Stable ABI translation strings (python#113638)

(cherry picked from commit ea978c6)
hugovk pushed a commit that referenced this issue Jan 3, 2024
…ed/Unstable API & Stable ABI translation strings (GH-113638) (#113676)

Co-authored-by: Ege Akman <egeakmanegeakman@hotmail.com>
hugovk pushed a commit that referenced this issue Jan 3, 2024
…ed/Unstable API & Stable ABI translation strings (#113638) (#113679)
@hugovk hugovk closed this as completed Jan 3, 2024
kulikjak pushed a commit to kulikjak/cpython that referenced this issue Jan 22, 2024
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes 3.12 only security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

2 participants