Untranslatable link text in whatsnew/3.10

[rffontenelle]

BPO	46130
Nosy	@JulienPalard, @miss-islington, @rffontenelle, @Fidget-Spinner
PRs	bpo-46130: docs: Make link text translatable in whatsnew/3.10 #30199 [3.10] bpo-46130: [docs] Add anchor for whatsnew/3.10 type hint section (GH-30199) #30201 docs: Fix typos and use anchor for internal link #30236

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2021-12-19.14:49:01.826>
created_at = <Date 2021-12-19.10:22:01.526>
labels = ['3.11', 'type-bug', '3.10', 'docs']
title = 'Untranslatable link text in whatsnew/3.10'
updated_at = <Date 2021-12-23.08:19:09.646>
user = 'https://github.com/rffontenelle'

bugs.python.org fields:

activity = <Date 2021-12-23.08:19:09.646>
actor = 'rffontenelle'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-12-19.14:49:01.826>
closer = 'kj'
components = ['Documentation']
creation = <Date 2021-12-19.10:22:01.526>
creator = 'rffontenelle'
dependencies = []
files = []
hgrepos = []
issue_num = 46130
keywords = ['patch']
message_count = 4.0
messages = ['408889', '408899', '408901', '408903']
nosy_count = 5.0
nosy_names = ['docs@python', 'mdk', 'miss-islington', 'rffontenelle', 'kj']
pr_nums = ['30199', '30201', '30236']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue46130'
versions = ['Python 3.10', 'Python 3.11']

[rffontenelle]

The following string can be found in What's New in Python 3.10 source file (Doc/whatsnew/3.10.rst):

For major changes, see New Features Related to Type Hints_.

where "New Features Related to Type Hints_" is a link to a section in the very same page with this name.

The issue with this link text is that translators should translate it (in python-doc organization in Transifex) but warning as errors will pop up if translated. For example, in Portuguese:

Para mais alterações, veja Novos recrusos relacionados a dicas de tipo_

or to

Para mais alterações, veja Novos recrusos relacionados a dicas de tipo <New Features Related to Type Hints>_

Sphinx would complain with:

Doc/whatsnew/3.10.rst:1432: WARNING: inconsistent references in translated message. original: ['New Features Related to Type Hints_'], translated: []

To solve this issue, I see two solutions:

1- Create an anchor for "New Features Related to Type Hints" section in this page (let's say, "new-feat-related-type-hints") and then call it like :ref:`new-feat-related-type-hints` so that it gets the section title name automatically. Translators won't need to edit it in order to get translated title name. (recommended)

2- Rewrite the source string adding the internal link to the paragraph using New Features Related to Type Hints <#new-features-related-to-type-hints>_, so that it can be translated without popping up the warning message.

[Fidget-Spinner]

New changeset 3d3615f by Rafael Fontenelle in branch 'main':
bpo-46130: [docs] Add anchor for whatsnew/3.10 type hint section (GH-30199)
3d3615f

[miss-islington]

New changeset 9a28cf1 by Miss Islington (bot) in branch '3.10':
bpo-46130: [docs] Add anchor for whatsnew/3.10 type hint section (GH-30199)
9a28cf1

[Fidget-Spinner]

Thanks Rafael for your efforts in docs translations.