Opened 4 years ago

Closed 3 years ago

Last modified 3 years ago

#17319 closed Cleanup/optimization (fixed)

Internationalization documentation

Reported by: dolma33@… Owned by: nobody
Component: Documentation Version: 1.3
Severity: Normal Keywords: internationalization
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

Ok, you won't believe this one: neither do I
(and I've seen a lot of mistakes done by myself during my programming years --- I'm not such an experienced programmer, but I try)

I'm so involved in internationalization, that I'm always reading online questions about this topic, trying to learn something more, and to help other people in the (rare) fortunate case that I know how to help them.

In several communities/forums/etc I've stumbled on several people posting tickets (with titles like "Django Internationalization not working" )
where the error was simply that they're copy-pasting the code in this documentation part
https://docs.djangoproject.com/en/1.3/topics/i18n/internationalization/#the-set-language-redirect-view
without noticing that in this line
<input name="next" type="hidden" value="/next/page/" />
The "/next/page/" string is just an example.
(They actually used "/next/page/" as a value)

Ok, things likte this can happen to everyone, we know that.
At the beginning I thought that it was because the askers were newbies, but I've seen this issue also from more advanced people...
The reason could be maybe distraction, maybe faith... I don't know...
But the fact is that too many programmers made the same mistake,
so maybe this part of the documentation could be improved in someway
(I don't know... maybe a simple change like "/next/page/path/" or "next_page" or "desired_next_page" could help)

Thank you

Anna Dolma Alonso
Biodiversity Informatics
Fundación Charles Darwin
Galapagos

Attachments (3)

django-17319-translation-docs.diff (563 bytes) - added by bpeschier 4 years ago.
17319.patch (1.3 KB) - added by aaugustin 4 years ago.
django-17319-update-translation-docs-2.patch (1.3 KB) - added by bpeschier 4 years ago.

Download all attachments as: .zip

Change History (9)

comment:1 Changed 4 years ago by bpeschier

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Please don't set the "has patch" flag without actually providing the patch as attachment!

A little nudge that the HTML uses an example url could not hurt; creating a patch for it.

Changed 4 years ago by bpeschier

comment:2 Changed 4 years ago by aaugustin

Oops, we just has a concurrency issue on this ticket :) Attaching my own version.

Changed 4 years ago by aaugustin

Changed 4 years ago by bpeschier

comment:3 Changed 4 years ago by bpeschier

aaugustin's version is better, just improved one sentence.

comment:4 Changed 3 years ago by jezdez

  • Triage Stage changed from Accepted to Ready for checkin

comment:5 Changed 3 years ago by aaugustin

  • Resolution set to fixed
  • Status changed from new to closed

In [17560]:

Fixed #17319 -- Made the example for set_language less error-prone. Thanks Anna Dolma Alonso for the report.

comment:6 Changed 3 years ago by aaugustin

In [17561]:

[1.3.X] Fixed #17319 -- Made the example for set_language less error-prone. Backport of r17560 from trunk.

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