Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#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)

comment:1 by Claude Paroz, 5 years ago

I'm not sure we should explain gettext functionality in Django docs. The use_fuzzy option 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_fuzzy explanation?

in reply to:  1 comment:2 by sebashwa, 5 years ago

Replying to Claude Paroz:

I'm not sure we should explain gettext functionality in Django docs. The use_fuzzy option 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_fuzzy explanation?

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 Mariusz Felisiak, 5 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 Mariusz Felisiak, 5 years ago

Has patch: set
Owner: changed from nobody to sebashwa
Status: new → assigned
Triage Stage: Accepted → Ready for checkin

​PR

comment:5 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

Resolution: → fixed
Status: assigned → closed

In 3d664a1:

Fixed #31690 -- Added note about fuzzy entries in translation docs.

comment:6 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

In 2d3b6bce:

[3.1.x] Fixed #31690 -- Added note about fuzzy entries in translation docs.

Backport of 3d664a158de18acf72fc8e0671f0f390cbca4b2e from master

comment:7 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

In 33767d5a:

[3.0.x] Fixed #31690 -- Added note about fuzzy entries in translation docs.

Backport of 3d664a158de18acf72fc8e0671f0f390cbca4b2e from master

Note: See TracTickets for help on using tickets.
Back to Top