1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Commit graph

6 commits

Author SHA1 Message Date
Burdette Lamar
b3123191c6
[DOC] Addition to encoding.rdoc (#5617)
Adds section "Transcoding a Stream," listing relevant methods in IO.
    Moves an example from section "String Encoding Example" to the new section.
    Removes header "String Encoding Example" for now-empty section.
    Changes items in section "Transcoding a String" from labeled list items to bullet list items. (Labeled list items are sometimes rendered with strange indentations for continued lines, and are always rendered with different indentations for the items.)
2022-03-02 14:26:20 -06:00
Burdette Lamar
7a6ba30c24
[DOC] Add encoding external/internal example to encoding.rdoc (#5610)
* Add encoding external/internal example to encoding.rdoc

* Add encoding external/internal example to encoding.rdoc

* Update doc/encoding.rdoc

I think there may be some more of these that I've recently put into io.c.  Will check tomorrow and create new PR if so.

Co-authored-by: Peter Zhu <peter@peterzhu.ca>

Co-authored-by: Peter Zhu <peter@peterzhu.ca>
2022-03-01 10:45:18 -06:00
Burdette Lamar
28ee1ca748
[DOC] Enhanced RDoc for encoding (#5603)
Additions and corrections for external/internal encodings.
2022-02-27 15:43:23 -06:00
Burdette Lamar
289a4cf672
[DOC] Extend intro/defn of 'transcoding' (#5602)
* Extend intro/defn of 'transcoding'
2022-02-27 06:44:58 -06:00
Burdette Lamar
c19a631c99
[DOC] Enhancements for encoding.rdoc (#5578)
Adds sections:

    String Encoding
    Symbol and Regexp Encodings
    Filesystem Encoding
    Locale Encoding
    IO Encodings
        External Encoding
        Internal Encoding
    Script Encoding
    Transcoding
        Transcoding a String
2022-02-24 14:10:49 -06:00
Burdette Lamar
883fe55c4b
New doc about encoding (#5572)
This is the beginning of an extended explication of Ruby encoding.

One of its more important jobs is to provide link targets for encoding documentation in other classes (String, File, IO, etc.). In particular, they can link to the "Encoding Options" section.

I'll have much to add to this document going forward, along with suitable adjustments in the class documentation.
2022-02-18 13:33:18 -06:00