Bug #5949: Add documentation introduction for the Encoding class

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: -
• ruby -v: 1.9.3

[Florent2 (Florent Guilleux)]

Add documentation introduction for the Encoding class

[Eregon (Benoit Daloze)]

Really nice documentation, thank you for writing this!

[mfn (Markus Fischer)]

Impressive, thanks!

I think you have a typo on line 1698 ; if it's supposed to be a ruby code example, the Encoding:ISO-8859-1 needs two double colons "::".

I was reading a few times through the external/internal encoding chapters, but I wish I'd really see an example making actual usage of an IO object; I think it would help tremendously to grasp the concept and apply it to real code.

Thank you

[drbrain (Eric Hodel)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r34608.
Florent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• encoding.c (Init_Encoding): Add Encoding documentation.
  [ruby-trunk - Bug #5949]
• encoding.c (rb_set_default_external): Fix typo in documentation.

[drbrain (Eric Hodel)]

Florent, I altered your original submission to recommend against Encoding.default_external= and Encoding.default_internal= as they cause issues with inconsistent encodings (see the individual method documentation). Also, please trim trailing whitespace.

I also fixed the typo and added the IO example requested by Markus

[Florent2 (Florent Guilleux)]

Thanks for your feedback and Eric for improving my submission! I've just seen your tweet Eric, sorry I had missed all the ticket updates, when I created the ticket I had not noticed that I was not watching it by default.