microbit-foundation / python-editor-v3

Micro:bit Educational Foundation Python Editor V3
https://python.microbit.org
MIT License
56 stars 37 forks source link

Crowdin missing strings for text revealed by "show more" in API docs #1069

Open martinwork opened 1 year ago

martinwork commented 1 year ago

Bug Description

Arising from support ticket https://support.microbit.org/helpdesk/tickets/58374 (private)

In a lot of sections of the API docs, the strings revealed by "show more" are not translated in any language.

They seem not to be on Crowdin.

How To Reproduce

Steps to reproduce the behavior:

  1. Go to 'https://python.microbit.org/v/3/api/gc'
  2. Click on 'Show more'
  3. Change the language
  4. See error

Screenshots

image

microbit-matt-hillsdon commented 1 year ago

This is intentional based on a judgement about what was reasonable to translate for the launch (which was in part commercially translated). We decided to focus on the API documentation that is shown elsewhere in the app, e.g. in parameter help or autocomplete documentation. Feedback on that decision and its impact on educational uses of the editor would be useful.

We document what's translated from the API documentation here: https://github.com/microbit-foundation/micropython-microbit-stubs/#translations

I'll raise this for discussion internally. My initial thoughts are that it makes sense to prioritise getting everything else to a high standard over these strings as that would get new languages to parity with the currently supported languages.

The other API content may need a different mapping to Crowdin than the simple key-value approach we've used for first lines so there are some technical challenges to consider as well as prioritisation of translator time (e.g. we have multiple paragraphs, blocks of code as examples in some cases).

One small step that would be less of a challenge would be adding the "return" documentation. This often overlaps with the first line, but sometimes contains useful extra detail.