Skip to content

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

Closed
@egeakman

Description

@egeakman

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.11only security fixes3.12only security fixes3.13bugs and security fixesdocsDocumentation in the Doc dir

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions