Missing Translations: Fix `_.trans()` In Napari

Hey guys! It seems our automated tests have flagged some missing translations in the napari project. Specifically, the tests detected missing _.trans() calls. Let's dive into what this means and how we can fix it!

You can check out the latest test output here to get a better understanding of the issue.

This issue is automatically managed, so it will update itself as we make progress, or a new one will pop up if more missing translations are found. Let's get to work!

Understanding the _.trans() Issue

So, what's the deal with these missing _.trans() calls? Well, in a nutshell, _.trans() is a function we use to mark text strings in our code that need to be translated into different languages. This is super important for making napari accessible to users all over the world! When we forget to wrap a string with _.trans(), it means that text will only appear in the default language (likely English), which isn't ideal.

Why is internationalization important? Because it opens napari up to a global audience. By providing translations, we make our software more user-friendly and inclusive. A user who speaks another language will feel much more comfortable using the software, which leads to a larger community.

What are the consequences of missing translations? The most immediate consequence is a fragmented user experience. Some parts of the interface will be in one language, while others will be in English. This can be confusing and frustrating, particularly for non-English speakers. Furthermore, it signals that the project does not fully support other languages, which could discourage international contributors and users.

How to identify the problem? The key is to look at the output provided in the link above. The test output shows exactly which strings are missing the translation wrapper. Look for any user-facing text that isn't wrapped in the _.trans() function call.

Addressing the Missing Translations

Now that we understand the problem, let's talk about how to fix it. There are two main scenarios here:

1. New strings that need internationalization: These are new pieces of text that we've added to the codebase that haven't been marked for translation yet. This is the most common case.
2. Strings that should be ignored: Sometimes, we have strings in our code that don't need to be translated. For example, technical terms, code snippets, or strings that are only used internally.

Internationalizing New Strings

If you've identified a string that needs to be translated, the fix is simple: just wrap it with _.trans()!

Example:

# Before:
message = "This is a new message"

# After:
message = _.trans("This is a new message")

Once you've made this change, the string will be included in the translation process. Translators will be able to provide translations for this string in different languages, and napari will automatically display the correct translation based on the user's language settings.

Make sure to add context when using _.trans(). Context can make the translation more accurate and less ambiguous, particularly for words with multiple meanings.

Ignoring Strings

If you've identified a string that shouldn't be translated, we need to tell our translation tools to ignore it. The exact method for doing this might vary depending on the specific tools we're using, but it usually involves adding a comment or attribute to the string to mark it as non-translatable.

Example:

# This string doesn't need to be translated
message = "CONSTANT_VALUE"  # i18n: ignore

By adding the i18n: ignore comment, we tell our translation tools to skip this string. It won't be included in the translation process, and it will always appear in the default language.

Diving Deeper: Contributing to napari Translations

So, you've fixed the missing _.trans() calls – awesome! But what if you want to take your contribution a step further and help with the actual translations?

How do the translations actually happen? Napari utilizes translation platforms, where translators from the community can contribute translations. These platforms manage translation files, which are then incorporated into the napari project.

Where can I find the translations to contribute? Check the napari documentation or community channels for information on accessing and contributing to the translation platform.

Best Practices for Internationalization

To avoid these issues in the future, let's keep these best practices in mind:

• Always use _.trans() for user-facing text: Make it a habit to wrap any text that will be displayed to the user with _.trans(). This will ensure that it's included in the translation process.
• Be mindful of context: Provide as much context as possible when using _.trans(). This will help translators provide accurate and appropriate translations.
• Use clear and concise language: Avoid jargon, slang, and overly complex sentence structures. This will make it easier for translators to understand the text and provide accurate translations.
• Test your changes: After making changes, test your changes with different language settings to ensure that the translations are displaying correctly.

Staying Updated

Remember, this issue will be automatically updated if kept open. This is an awesome way for the system to self-manage translation efforts and to keep the napari project globally accessible!

How does the auto-update work? The cron script runs regularly. It checks for new instances of user-facing text that are not wrapped in _.trans(). If it finds any, it updates the issue (if it's open) or creates a new issue.

Can I improve the auto-update? Yes, absolutely! If you have ideas for making the auto-update more informative or efficient, feel free to suggest improvements to the cron script. Maybe include more details about the location of the untranslated string, or give suggestions of how to fix it.

Conclusion

So there you have it! By understanding the importance of internationalization and following these guidelines, we can make napari a truly global project. Let's work together to ensure that napari is accessible to everyone, regardless of their language! Happy translating, folks!