Internationalization Flutter "description" key in .arb files

June 3, 2022

I’m having questions about internationalization in my Flutter App
I’m trying to get inspired from I/O Pinball project from VGV

In their l10n file they have a "description" for each string, is it for accessibility ?

{
  "@@locale": "en",
  "play": "Play",
  "@play": {
    "description": "Text displayed on the landing page play button"
  },
  "howToPlay": "How to Play",
  "@howToPlay": {
    "description": "Text displayed on the landing page how to play button"
  }
}

Does this "description" show up in voice over on iPhone ?
What should be the approach for writing such description ?

-> Should it give details about the position of the string or label on the screen and so on… ?

>Solution :

It’s metadata for the people who will be translating your strings – Including descriptions that give context to your localizable strings helps the translators produce more accurate translations.