Scripting: create possibility to distinguish if technical strings ('unexpected translations') were localized on purpose or altered by mistake by tygrysek90 · Pull Request #3309 · OpenRCT2/Localisation

tygrysek90 · 2025-08-09T20:53:40Z

This PR:

changes slightly wording in translation_check.py in line for so-called 'Unexpected' translations, produces warning Warning: Supossed to remain intact <- foremost-ly to avoid possible confusion, to be more clear and understandable for future use
since it was found that some so-called technical strings, as found in KEYS_TO_IGNORE are necessary to be localized in a few translations, a warning suppression mechanism is created:
- this expects each language maintainer reviewing issued warning (checking if localization is needed or string was changed by mistake)
- in case language maintainer finds that strings must be somehow localized, language maintainer will need to commit PR adding respective STR_numbers to newly created suppress_warning.py
  - this happens while taking advantage of all existing procedures (PR-s, comments, blame history, etc) which we like to use
the PR tackles part of problems defined by discussion with @tupaschoal in
- Remove unexpected translations from all languages #3302
opening currently as draft - to discuss - if nothing else, there is probably bunch of typos, as I realized i don't have a spellcheck in IDLE
thank you for reading

github-actions · 2025-08-09T20:54:03Z

Check results

For details go to Translation Check -> Details. Expand Run checks build stage and use the build-in search to find your language (e.g. pl-PL)

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Not needed The translation file contains entries that are not in `en-GB` and should be removed (e.g. STR_9999 exists in given language but is not in `en-GB`)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)

Other translations

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)
`ar-EG`	277	1728
`ca-ES`	18	91
`cs-CZ`	0	150
`da-DK`	13	324
`de-DE`	11	147
`en-US`	3453	1
`eo-ZZ`	2	72
`es-ES`	8	166
`fi-FI`	97	95
`fr-CA`	3618	0
`fr-FR`	2	144
`gl-ES`	2	94
`hu-HU`	0	95
`it-IT`	20	138
`ja-JP`	97	121
`ko-KR`	0	95
`nb-NO`	186	162
`nl-NL`	11	184
`pl-PL`	60	99
`pt-BR`	0	142
`ru-RU`	0	118
`sv-SE`	8	161
`tr-TR`	515	98
`uk-UA`	181	719
`vi-VN`	25	117
`zh-CN`	8	36
`zh-TW`	44	115

tupaschoal

I like this idea, of course we should first make sure there are no current wrong "keys_to_ignore", to clean up from the main list, then we can add exclusions here.

.github/workflows/supress_warning.py

.github/workflows/translation_check.py

.github/workflows/supress_warning.py

Co-authored-by: Tulio Leao <tupaschoal@gmail.com>

github-actions · 2025-08-10T15:14:39Z

Check results

For details click the build job and expand Run checks on the CI logs.

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Not needed The translation file contains entries that are not in `en-GB` and should be removed (e.g. STR_9999 exists in given language but is not in `en-GB`)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)

Other translations

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)
`ar-EG`	278	1728
`ca-ES`	19	91
`cs-CZ`	1	150
`da-DK`	14	324
`de-DE`	12	147
`en-US`	3454	1
`eo-ZZ`	3	72
`es-ES`	9	166
`fi-FI`	98	95
`fr-CA`	3619	0
`fr-FR`	3	144
`gl-ES`	3	94
`hu-HU`	1	95
`it-IT`	21	138
`ja-JP`	98	121
`ko-KR`	1	95
`nb-NO`	187	162
`nl-NL`	12	184
`pl-PL`	61	99
`pt-BR`	1	142
`ru-RU`	1	118
`sv-SE`	9	161
`tr-TR`	516	98
`uk-UA`	182	719
`vi-VN`	26	117
`zh-CN`	9	36
`zh-TW`	45	115

Co-authored-by: Tulio Leao <tupaschoal@gmail.com>

github-actions · 2025-08-10T15:15:01Z

Check results

For details click the build job and expand Run checks on the CI logs.

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Not needed The translation file contains entries that are not in `en-GB` and should be removed (e.g. STR_9999 exists in given language but is not in `en-GB`)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)

Other translations

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)
`ar-EG`	278	1728
`ca-ES`	19	91
`cs-CZ`	1	150
`da-DK`	14	324
`de-DE`	12	147
`en-US`	3454	1
`eo-ZZ`	3	72
`es-ES`	9	166
`fi-FI`	98	95
`fr-CA`	3619	0
`fr-FR`	3	144
`gl-ES`	3	94
`hu-HU`	1	95
`it-IT`	21	138
`ja-JP`	98	121
`ko-KR`	1	95
`nb-NO`	187	162
`nl-NL`	12	184
`pl-PL`	61	99
`pt-BR`	1	142
`ru-RU`	1	118
`sv-SE`	9	161
`tr-TR`	516	98
`uk-UA`	182	719
`vi-VN`	26	117
`zh-CN`	9	36
`zh-TW`	45	115

github-actions · 2025-08-10T15:18:00Z

Check results

For details click the build job and expand Run checks on the CI logs.

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Not needed The translation file contains entries that are not in `en-GB` and should be removed (e.g. STR_9999 exists in given language but is not in `en-GB`)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)

Other translations

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)
`ar-EG`	278	1728
`ca-ES`	19	91
`cs-CZ`	1	150
`da-DK`	14	324
`de-DE`	12	147
`en-US`	3454	1
`eo-ZZ`	3	72
`es-ES`	9	166
`fi-FI`	98	95
`fr-CA`	3619	0
`fr-FR`	3	144
`gl-ES`	3	94
`hu-HU`	1	95
`it-IT`	21	138
`ja-JP`	98	121
`ko-KR`	1	95
`nb-NO`	187	162
`nl-NL`	12	184
`pl-PL`	61	99
`pt-BR`	1	142
`ru-RU`	1	118
`sv-SE`	9	161
`tr-TR`	516	98
`uk-UA`	182	719
`vi-VN`	26	117
`zh-CN`	9	36
`zh-TW`	45	115

github-actions · 2025-08-10T15:18:52Z

Check results

For details click the build job and expand Run checks on the CI logs.

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Not needed The translation file contains entries that are not in `en-GB` and should be removed (e.g. STR_9999 exists in given language but is not in `en-GB`)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)

Other translations

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)
`ar-EG`	278	1728
`ca-ES`	19	91
`cs-CZ`	1	150
`da-DK`	14	324
`de-DE`	12	147
`en-US`	3454	1
`eo-ZZ`	3	72
`es-ES`	9	166
`fi-FI`	98	95
`fr-CA`	3619	0
`fr-FR`	3	144
`gl-ES`	3	94
`hu-HU`	1	95
`it-IT`	21	138
`ja-JP`	98	121
`ko-KR`	1	95
`nb-NO`	187	162
`nl-NL`	12	184
`pl-PL`	61	99
`pt-BR`	1	142
`ru-RU`	1	118
`sv-SE`	9	161
`tr-TR`	516	98
`uk-UA`	182	719
`vi-VN`	26	117
`zh-CN`	9	36
`zh-TW`	45	115

github-actions · 2025-08-10T17:23:52Z

Check results

For details click the build job and expand Run checks on the CI logs.

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Not needed The translation file contains entries that are not in `en-GB` and should be removed (e.g. STR_9999 exists in given language but is not in `en-GB`)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)

Other translations

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)
`ar-EG`	278	1728
`ca-ES`	19	91
`cs-CZ`	1	150
`da-DK`	14	324
`de-DE`	12	147
`en-US`	3454	1
`eo-ZZ`	3	72
`es-ES`	9	166
`fi-FI`	98	95
`fr-CA`	3619	0
`fr-FR`	3	144
`gl-ES`	3	94
`hu-HU`	1	95
`it-IT`	21	138
`ja-JP`	98	121
`ko-KR`	1	95
`nb-NO`	187	162
`nl-NL`	12	184
`pl-PL`	61	99
`pt-BR`	1	142
`ru-RU`	1	118
`sv-SE`	9	161
`tr-TR`	516	98
`uk-UA`	182	719
`vi-VN`	26	117
`zh-CN`	9	36
`zh-TW`	45	115

github-actions · 2025-08-10T17:34:28Z

Check results

For details click the build job and expand Run checks on the CI logs.

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Not needed The translation file contains entries that are not in `en-GB` and should be removed (e.g. STR_9999 exists in given language but is not in `en-GB`)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)

Other translations

	Missing The translation is not added to translation file. (e.g. STR_9999 is in `en-GB` but is not available in given language)	Same The translation and source string is exactly the same. (e.g. STR_9999 is `Umbrella` in both `en-GB` and given language). This may be desired in some cases (e.g. `April` is the same in English and German)
`ar-EG`	278	1728
`ca-ES`	19	91
`cs-CZ`	1	150
`da-DK`	14	324
`de-DE`	12	147
`en-US`	3454	1
`eo-ZZ`	3	72
`es-ES`	9	166
`fi-FI`	98	95
`fr-CA`	3619	0
`fr-FR`	3	144
`gl-ES`	3	94
`hu-HU`	1	95
`it-IT`	21	138
`ja-JP`	98	121
`ko-KR`	1	95
`nb-NO`	187	162
`nl-NL`	12	184
`pl-PL`	61	99
`pt-BR`	1	142
`ru-RU`	1	118
`sv-SE`	9	161
`tr-TR`	516	98
`uk-UA`	182	719
`vi-VN`	26	117
`zh-CN`	9	36
`zh-TW`	45	115

tygrysek90 · 2025-08-10T17:38:32Z

At this point, suggested and requested changes were incorporated, typos fixed (spelling of the word suppress...)

Only point remaining that is not fine remains:

print(f'Translation not expected ({len(messages["unexpected"])})\nPlease review and if OK, add to suppress_warning.py:')

Maybe could we call it technical string? And have the message "Technical string modified in translation"?

What do you think @tupaschoal ?

tupaschoal · 2025-08-11T09:49:38Z

Maybe could we call it technical string? And have the message "Technical string modified in translation"?

I think it sounds fine, something like:

Technical strings modified (XX).\nIt's not expected for these to be translated, but if it makes sense for your language, add a waiver for them on suppress_warning.py and open a PR explaining why"?

It's a bit lengthy, but I think it's alright (we might want to break into two or three print/lines to make more readable on the actual script.

tygrysek90 · 2025-08-11T10:17:54Z

It's a bit lengthy, but I think it's alright (we might want to break into two or three print/lines to make more readable on the actual script.

For me personally, it is better to receive longer, but clearer message than to get stub of sentence that will keep me puzzled for next week ;)

For sake of well-reading formatted to 80 column width:

Technical strings modified (XX).\n
It's not expected for these to be translated, but if it makes sense for your
language, add a waiver for them on suppress_warning.py and open a PR explaining
why.

I will update the PR soon with this version

modify action log message for "unexpected" to "Technical strings modified" add condition for explanation message to be shown only if there are "technical strings modified"

tygrysek90 · 2025-08-11T11:33:04Z

Found that 80 column width is too narrow, hence I chosen to break it in two so it is easier to read and looks logical -
one line is as cause and second as solution

I fined tuned it with commit above, adding condition for the longer (explanation) part of text to be printed only in case there are some "Technical strings modified"

Here is screenshot of output in staged repository:

I feel the PR is ready now.

(We could add Technical strings to comment output, just for one language at time but I would leave that to another time)

tupaschoal

Are the suppressions final or do you intend to patch other languages too?

.github/workflows/translation_check.py

Co-authored-by: Tulio Leao <tupaschoal@gmail.com>

tygrysek90 · 2025-08-12T10:33:47Z

Are the suppressions final or do you intend to patch other languages too?

Well that is a good question! I have filled the given list with something (so it makes some sense while write-test-review process).

However now I feel I should actually purge the suppression list.

For sake of cleanliness and serving complete process:

language maintainer observes script output (or repo maintainer observes and creates issue for lang maintainer)
language maintainer decides what action to take
language maintainer submits a PR resolving situation - a: reverts translation, b: suppresses warning

Here now, we (together with @tupaschoal ) are standing as script writers. We give a tool - none of us can not say whether it is right or wrong to have it translated (there might be reasons it is good or bad beyond our understanding, beyond facts we can see from our perspectives)

To metaphor, when you buy impact drill, the shop assistant will not tell you where you should drill :)

to have a clean start

Create warning-supression mechanism, modify 'unexpected' output

7155216

tupaschoal requested changes Aug 10, 2025

View reviewed changes

.github/workflows/supress_warning.py Outdated Show resolved Hide resolved

.github/workflows/translation_check.py Outdated Show resolved Hide resolved

.github/workflows/supress_warning.py Outdated Show resolved Hide resolved

Update comment

522c242

Co-authored-by: Tulio Leao <tupaschoal@gmail.com>

Update text

ff0e545

Co-authored-by: Tulio Leao <tupaschoal@gmail.com>

remove unnecessary class that was trying to unnecessarily hide error

99502eb

fix comment wording

694ef9b

fix typos, improve comments

5d6f171

fix typo

37eeb02

modify output message, add condition for hint text

dc0bc5f

modify action log message for "unexpected" to "Technical strings modified" add condition for explanation message to be shown only if there are "technical strings modified"

tygrysek90 marked this pull request as ready for review August 11, 2025 11:33

tygrysek90 requested a review from tupaschoal August 11, 2025 11:33

tupaschoal reviewed Aug 12, 2025

View reviewed changes

.github/workflows/translation_check.py Outdated Show resolved Hide resolved

.github/workflows/translation_check.py Outdated Show resolved Hide resolved

tygrysek90 and others added 2 commits August 12, 2025 12:20

remove redundant function call

7ee206b

Co-authored-by: Tulio Leao <tupaschoal@gmail.com>

fix unclear output message

8198fbd

Co-authored-by: Tulio Leao <tupaschoal@gmail.com>

purge suppression list

af35a57

to have a clean start

tygrysek90 requested a review from tupaschoal August 12, 2025 10:38

tupaschoal approved these changes Aug 14, 2025

View reviewed changes

tupaschoal merged commit df96aba into OpenRCT2:master Aug 14, 2025

tupaschoal mentioned this pull request Aug 14, 2025

Review translated technical strings #3314

Open

26 tasks

tygrysek90 mentioned this pull request Aug 20, 2025

Add a wiki link into README.md #3325

Closed

tygrysek90 deleted the origin/scripting-unexpected-modify branch September 15, 2025 05:03

Conversation

tygrysek90 commented Aug 9, 2025

Uh oh!

github-actions bot commented Aug 9, 2025

Check results

Uh oh!

tupaschoal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Aug 10, 2025

Check results

Uh oh!

github-actions bot commented Aug 10, 2025

Check results

Uh oh!

github-actions bot commented Aug 10, 2025

Check results

Uh oh!

github-actions bot commented Aug 10, 2025

Check results

Uh oh!

github-actions bot commented Aug 10, 2025

Check results

Uh oh!

github-actions bot commented Aug 10, 2025

Check results

Uh oh!

tygrysek90 commented Aug 10, 2025

Uh oh!

tupaschoal commented Aug 11, 2025

Uh oh!

tygrysek90 commented Aug 11, 2025

Uh oh!

tygrysek90 commented Aug 11, 2025

Uh oh!

tupaschoal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tygrysek90 commented Aug 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants