ruby-changes:35326
From: hsbt <ko1@a...>
Date: Fri, 5 Sep 2014 19:00:57 +0900 (JST)
Subject: [ruby-changes:35326] hsbt:r47408 (trunk): * lib/shellwords.rb: proofreading documentation.
hsbt 2014-09-05 19:00:46 +0900 (Fri, 05 Sep 2014) New Revision: 47408 http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=47408 Log: * lib/shellwords.rb: proofreading documentation. [Bug #10155][ruby-core:64471] Modified files: trunk/ChangeLog trunk/lib/shellwords.rb Index: ChangeLog =================================================================== --- ChangeLog (revision 47407) +++ ChangeLog (revision 47408) @@ -1,3 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/ChangeLog#L1 +Fri Sep 5 19:00:40 2014 SHIBATA Hiroshi <shibata.hiroshi@g...> + + * lib/shellwords.rb: proofreading documentation. + [Bug #10155][ruby-core:64471] + Fri Sep 5 18:34:33 2014 Laurent Arnoud <laurent@s...> * test/csv/test_row.rb: Added some missing tests in CSV. Index: lib/shellwords.rb =================================================================== --- lib/shellwords.rb (revision 47407) +++ lib/shellwords.rb (revision 47408) @@ -9,7 +9,7 @@ https://github.com/ruby/ruby/blob/trunk/lib/shellwords.rb#L9 # # === Usage # -# You can use shellwords to parse a string into a Bourne shell friendly Array. +# You can use Shellwords to parse a string into a Bourne shell friendly Array. # # require 'shellwords' # @@ -27,7 +27,7 @@ https://github.com/ruby/ruby/blob/trunk/lib/shellwords.rb#L27 # argv = "they all ran after the farmer's wife".shellsplit # #=> ArgumentError: Unmatched double quote: ... # -# In this case, you might want to use Shellwords.escape, or it's alias +# In this case, you might want to use Shellwords.escape, or its alias # String#shellescape. # # This method will escape the String for you to safely use with a Bourne shell. @@ -42,7 +42,7 @@ https://github.com/ruby/ruby/blob/trunk/lib/shellwords.rb#L42 # system(argv.shelljoin) # # You can use this method to create an escaped string out of an array of tokens -# separated by a space. In this example we'll use the literal shortcut for +# separated by a space. In this example we used the literal shortcut for # Array.new. # # === Authors @@ -117,7 +117,7 @@ module Shellwords https://github.com/ruby/ruby/blob/trunk/lib/shellwords.rb#L117 # It is the caller's responsibility to encode the string in the right # encoding for the shell environment where this string is used. # - # Multibyte characters are treated as multibyte characters, not bytes. + # Multibyte characters are treated as multibyte characters, not as bytes. # # Returns an empty quoted String if +str+ has a length of zero. def shellescape(str) @@ -128,13 +128,13 @@ module Shellwords https://github.com/ruby/ruby/blob/trunk/lib/shellwords.rb#L128 str = str.dup - # Treat multibyte characters as is. It is caller's responsibility + # Treat multibyte characters as is. It is the caller's responsibility # to encode the string in the right encoding for the shell # environment. str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1") # A LF cannot be escaped with a backslash because a backslash + LF - # combo is regarded as line continuation and simply ignored. + # combo is regarded as a line continuation and simply ignored. str.gsub!(/\n/, "'\n'") return str @@ -149,8 +149,8 @@ module Shellwords https://github.com/ruby/ruby/blob/trunk/lib/shellwords.rb#L149 # Builds a command line string from an argument list, +array+. # # All elements are joined into a single string with fields separated by a - # space, where each element is escaped for Bourne shell and stringified using - # +to_s+. + # space, where each element is escaped for the Bourne shell and stringified + # using +to_s+. # # ary = ["There's", "a", "time", "and", "place", "for", "everything"] # argv = Shellwords.join(ary) @@ -206,7 +206,7 @@ class Array https://github.com/ruby/ruby/blob/trunk/lib/shellwords.rb#L206 # array.shelljoin => string # # Builds a command line string from an argument list +array+ joining - # all elements escaped for Bourne shell and separated by a space. + # all elements escaped for the Bourne shell and separated by a space. # # See Shellwords.shelljoin for details. def shelljoin -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/