User facing messages/warnings/errors should be localized, and documented #79173

Activity

1. radical

   added

   area-Build-mono

   on Dec 2, 2022
2. ghost added

   untriagedNew issue has not been triaged by the area ownerNew issue has not been triaged by the area owner

   on Dec 2, 2022
3. radical

   added this to the 8.0.0 milestone on Dec 2, 2022
4. ghost removed

   untriagedNew issue has not been triaged by the area ownerNew issue has not been triaged by the area owner

   on Dec 2, 2022
5. radical

   changed the title [-]User facing messages/warnings/errors should be localized[/-] [+]User facing messages/warnings/errors should be localized, and documented[/+] on Dec 2, 2022
6. lewing

   assigned

   ilonatommy

   on May 16, 2024
7. lewing

   modified the milestones: 8.0.0, 8.0.x, 9.0.0 on May 16, 2024
8. ilonatommy commented on May 17, 2024

   

   ilonatommy

   on May 17, 2024

   Member

   More actions

   Questions:

   • Do all 3 need that treatment?
   • Are there any existing cases where such messages are localized that can be used as examples to do this?
   • Do the user-facing Errors need to be assigned codes too?
   • Where, and how should the Errors, and Warnings be documented?

   My plan, please let me know if it can be improved:

   • Errors and warnings should be localized. I am not sure about messages, it will depend on the amount of work connected with it.
   • We are localizing a bunch of strings in libs, e.g.:
     https://github.com/dotnet/runtime/tree/1df411180b30546cf58426d18b1c86b704f0753a/src/libraries/Microsoft.CSharp/src/MultilingualResources
     https://github.com/dotnet/runtime/tree/1df411180b30546cf58426d18b1c86b704f0753a/src/libraries/System.Runtime.InteropServices/gen/Common/Resources/xlf
     but some of them e just keep in English version as resources, no translations:
     https://github.com/dotnet/runtime/blob/1df411180b30546cf58426d18b1c86b704f0753a/src/libraries/System.Private.CoreLib/src/Resources/Strings.resx
   • Yes. E.g. users can suppress specific warnings using the codes. What's more, codes should be unique for a given string, so we can use them as keys for localization.
   • Compilation errors are documented here and only them. Aspnetcore codes are documented in their repo here and this looks like a good pattern. To keep it simple, I would create same-named doc in the corresponding location in runtime repo: https://github.com/dotnet/runtime/tree/main/docs
9. ilonatommy commented on Jun 3, 2024

   

   ilonatommy

   on Jun 3, 2024

   Member

   More actions

   Connected issue: #85067
10. lewing

    modified the milestones: 9.0.0, 10.0.0 on Jul 31, 2024
11. lewing

    assigned

    akoeplinger

    and unassigned

    ilonatommy

    on Jun 21, 2025
12. akoeplinger

    modified the milestones: 10.0.0, 11.0.0 on Aug 18, 2025
13. lewing

    modified the milestones: 11.0.0, Future on Jul 19, 2026