Skip to content

Commit

Permalink
[DOC] encodings.rdoc: universal_newline reacts to \r
Browse files Browse the repository at this point in the history
It wasn't clear that the mode also translates "\r" to "\n".
  • Loading branch information
XrXr committed Dec 22, 2022
1 parent 95a1d1f commit bba2bfc
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions doc/encodings.rdoc
Expand Up @@ -467,12 +467,13 @@ These keyword-value pairs specify encoding options:
with a carriage-return character (<tt>"\r"</tt>).
- <tt>:crlf_newline: true</tt>: Replace each line-feed character (<tt>"\n"</tt>)
with a carriage-return/line-feed string (<tt>"\r\n"</tt>).
- <tt>:universal_newline: true</tt>: Replace each carriage-return/line-feed string
- <tt>:universal_newline: true</tt>: Replace each carriage-return
character (<tt>"\r"</tt>) and each carriage-return/line-feed string
(<tt>"\r\n"</tt>) with a line-feed character (<tt>"\n"</tt>).

Examples:

s = "\n \r\n" # => "\n \r\n"
s.encode('ASCII', cr_newline: true) # => "\r \r\r"
s.encode('ASCII', crlf_newline: true) # => "\r\n \r\r\n"
s.encode('ASCII', universal_newline: true) # => "\n \n"
s = "\n \r \r\n" # => "\n \r \r\n"
s.encode('ASCII', cr_newline: true) # => "\r \r \r\r"
s.encode('ASCII', crlf_newline: true) # => "\r\n \r \r\r\n"
s.encode('ASCII', universal_newline: true) # => "\n \n \n"

0 comments on commit bba2bfc

Please sign in to comment.