[DOC] Main doc for encodings moved from encoding.c to doc/encodings.rdoc #5748
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BurdetteLamar
changed the title
jeremyevans
requested changes
Apr 1, 2022
encoding.c
Outdated
| * "R\u00E9sum\u00E9" | ||
| * Encoding::ASCII_8BIT is a special-purpose encoding that is usually used for | ||
| * a string of bytes, not a string of characters. | ||
| * But as the name insists, its characters in the ASCII range |
encoding.c
Outdated
| * a string of bytes, not a string of characters. | ||
| * But as the name insists, its characters in the ASCII range | ||
| * are considered as ASCII characters. | ||
| * This is useful when you use ASCII-8BIT characters with |
There was a problem hiding this comment.
s/This is useful.../This is useful when you use other ASCII-compatible encodings./
encoding.c
Outdated
| * external encoding must be specified to obtain the correct result. | ||
| * Encodings are important for Ruby strings. | ||
| * They are also important in other contexts: symbols, regexps, filesystems, | ||
| * locales, streams, and scripts. |
There was a problem hiding this comment.
I would drop this paragraph. It's true that encodings are important for Ruby String, Symbol, Regexp, and IO instances. However, Ruby doesn't really have filesystems, locales, or scripts as core objects, so this reads awkwardly to me. I don't think the paragraph adds value, so I recommend removing it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A while back I merged doc/encoding.rdoc, which is a full discussion of encodings, meant to replace most of the discussion in encoding.c itself. This was discussed at length in PR 5578.
Now is the time to enact the replacement by removing some discussion from encoding.c, and instead linking to the new doc.