#31690 closed Cleanup/optimization (fixed)
Note fuzzy entries in translation docs.
| Reported by: | sebashwa | Owned by: | sebashwa |
|---|---|---|---|
| Component: | Documentation | Version: | 3.0 |
| Severity: | Normal | Keywords: | translation i18n fuzzy compilemessages makemessages |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
I would like to add a passage about how fuzzy strings are handled by the compilemessages command here: https://docs.djangoproject.com/en/3.0/topics/i18n/translation/#miscellaneous
I'm pretty new to gettext and didn't know about the concept of fuzzy translations. I overlooked / ignored the fuzzy statements, which were automatically generated by invoking makemessages. It cost me quite some time today to figure out why those translations did not work and I think this may have been prevented by some documentation about it.
I hereby want to reassure that this is a feasible thing to add.
Change History (7)
follow-up: 2 comment:1 by , 4 years ago
comment:2 by , 4 years ago
Replying to Claude Paroz:
I'm not sure we should explain
gettextfunctionality in Django docs. Theuse_fuzzyoption in https://docs.djangoproject.com/en/stable/ref/django-admin/#django-admin-compilemessages should be a good hint to check if something doesn't work the way you think.
Maybe linking to https://www.gnu.org/software/gettext/manual/html_node/Fuzzy-Entries.html in theuse_fuzzyexplanation?
I agree that this should rather be a short hint and not a fully fledged explanation. But I especially would like to mention the fact somewhere in the django docs, that those fuzzy translations are automatically generated by makemessages sometimes. So maybe a small hint box here: https://docs.djangoproject.com/en/3.0/topics/i18n/translation/#message-files stating that this can happen (and maybe when it happens) is the way to go? Including the link to the docs at gnu.org you are mentioning would work fine here as well.
comment:3 by , 4 years ago
| Summary: | Document how fuzzy strings are handled by compilemessages → Note fuzzy entries in translation docs. |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
Agreed. We can add a small note to the Message files docs about fuzzy entries and a reference to the to https://www.gnu.org/software/gettext/manual/html_node/Fuzzy-Entries.html in the use_fuzzy explanation.
comment:4 by , 4 years ago
| Has patch: | set |
|---|---|
| Owner: | changed from to |
| Status: | new → assigned |
| Triage Stage: | Accepted → Ready for checkin |
I'm not sure we should explain
gettextfunctionality in Django docs. Theuse_fuzzyoption in https://docs.djangoproject.com/en/stable/ref/django-admin/#django-admin-compilemessages should be a good hint to check if something doesn't work the way you think.Maybe linking to https://www.gnu.org/software/gettext/manual/html_node/Fuzzy-Entries.html in the
use_fuzzyexplanation?