Add FAQ entry regarding StrPromise to README #1320
Conversation
README.md
Outdated
| errors.add(_('Error message')) | ||
| ``` | ||
|
|
||
| If this is reported on Django code, please report an issue or open a pull request. |
There was a problem hiding this comment.
Sometimes also the correct solution is to call str(value) on the StrPromise, for example when passing to a third party library that expects a str type value. Although when done incorrectly, this may result in the translation being evaluated too early.
There was a problem hiding this comment.
Thanks, I can add this. Are you aware of any documentation on when it might be sufficient to evaluate translations (too) early?
There was a problem hiding this comment.
This looks like the perfect piece of documentation to link to: https://docs.djangoproject.com/en/4.1/topics/i18n/translation/#working-with-lazy-translation-objects
There was a problem hiding this comment.
In particular:
Using gettext_lazy() and ngettext_lazy() to mark strings in models and utility functions is a common operation. When you’re working with these objects elsewhere in your code, you should ensure that you don’t accidentally convert them to strings, because they should be converted as late as possible (so that the correct locale is in effect). This necessitates the use of the helper function described next.
There was a problem hiding this comment.
Thanks, that's great. I revised the text and removed the code snippet.
mschoettle
force-pushed
the
improve-readme
branch
from
f8e5582 to
5d3aa2d
Compare
|
Thanks! I suggest you add a direct link to https://docs.djangoproject.com/en/4.1/topics/i18n/translation/#working-with-lazy-translation-objects as well. Maybe instead of one of the GitHub links. |
mschoettle
force-pushed
the
improve-readme
branch
from
5d3aa2d to
6596039
Compare
Ah, apologies! I forgot to add the link to the text. I had it in the second paragraph (fixed). If you prefer that I replace one of the GitHub links as well I can do that (I would change the link to "cannot be used interchangeably" then). |
Na it was just a thought. |
I have made things!
Follow-up from my question in #1319, this PR adds a FAQ entry to the README with a small code snippet.
The first commit addresses some markdownlint violations (still 1 left).
Related issues
Refs #1319, #689