Add `Gettext.example` macro about gettext

[dkuku]

Adding the available assigns in the comment may be also a good option. Sometimes there is an assign that is not used in English but is still available and may be required in other language.

[whatyouhide]

@dkuku thanks for the feature request. Do you know if GNU Gettext provides anything like this? cc @maennchen

[dkuku]

@whatyouhide
I just did a quick search and there are multiple types of comments:

white-space
#  translator-comments
#. extracted-comments
#: reference…
#, flag…
#| msgid previous-untranslated-string
msgid untranslated-string
msgstr translated-string

And the example on wikipedia suggests that there are also common prefixes used which I think can be a good fit for it:

#. TRANSLATORS: %s contains the user's name as specified in Preferences
#, c-format
#: src/name.c:36
msgid "My name is %s.\n"
msgstr ""

[whatyouhide]

@dkuku we already support many of those comments. I’m talking about whether GNU Gettext does something specific to examples and binding documentation.

[dkuku]

I'm afraid this is not supported by gettext

[whatyouhide]

Gotcha! Then, for now I'd prefer to keep things simple and keep this closer to GNU Gettext. You can still achieve something very close to this with the comment macro. Post 1.0 of Gettext we might revisit this, but for now we really don't have the bandwidth to address this. Thanks for the proposal! 💟