Bug #5949
Add documentation introduction for the Encoding class
| Status: | Closed | Start date: | 01/31/2012 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | % Done: | 100% |
||
| Category: | DOC | |||
| Target version: | - | |||
| ruby -v: | 1.9.3 |
Description
Add documentation introduction for the Encoding class
Associated revisions
* encoding.c (Init_Encoding): Add Encoding documentation.
[ruby-trunk - Bug #5949]
* encoding.c (rb_set_default_external): Fix typo in documentation.
* encoding.c (Init_Encoding): Add IO example of internal and external
encoding. Fixed a typo in the force_encoding example. [#5949]
History
Updated by Eregon (Benoit Daloze) 4 months ago
Really nice documentation, thank you for writing this!
Updated by mfn (Markus Fischer) 4 months ago
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
Updated by drbrain (Eric Hodel) 3 months ago
- 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.
Updated by drbrain (Eric Hodel) 3 months ago
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
Updated by Florent2 (Florent Guilleux) 3 months ago
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.