diff options
author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2020-08-20 12:09:49 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-08-20 12:09:49 -0500 |
commit | 51525557fd75ca97e6347e2913f2d7fa25e8f789 (patch) | |
tree | ba6e4df1c23b995aa470a8d259030ca4be2282bd /string.c | |
parent | 1d1e36fab60a5409da6f6a26c707ce828b9b75d5 (diff) |
Partial compliance with doc/method_documentation.rdoc in string.c (#3436)
Removes references to *-convertible thingies.
Notes
Notes:
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
Diffstat (limited to 'string.c')
-rw-r--r-- | string.c | 27 |
1 files changed, 4 insertions, 23 deletions
@@ -1559,18 +1559,12 @@ rb_str_resurrect(VALUE str) * String.new(str='', encoding: enc) -> new_str * String.new(str='', capacity: size) -> new_str * - * Argument +str+, if given, it must be a - * {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects] - * (implements +to_str+). + * Argument +str+, if given, it must be a \String. * - * Argument +encoding+, if given, must be: - * - A {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects] - * (implements +to_str+). - * - The name of an encoding that is compatible with +str+. + * Argument +encoding+, if given, must be the \String name of an encoding + * that is compatible with +str+. * - * Argument +capacity+, if given, must be an - * {Integer-convertible object}[doc/implicit_conversion_rdoc.html#label-Integer-Convertible+Objects] - * (implements +to_int+). + * Argument +capacity+, if given, must be an \Integer. * * The +str+, +encoding+, and +capacity+ arguments may all be used together: * String.new('hello', encoding: 'UTF-8', capacity: 25) @@ -1621,15 +1615,6 @@ rb_str_resurrect(VALUE str) * * --- * - * Raises an exception if +str+ is not \String-convertible: - * # Raises TypeError (no implicit conversion of Integer into String): - * String.new(0) - * - * Raises an exception if +encoding+ is not \String-convertible - * or an Encoding object: - * # Raises TypeError (no implicit conversion of Integer into String): - * String.new(encoding: 0) - * * Raises an exception if the given +encoding+ is not a valid encoding name: * # Raises ArgumentError (unknown encoding name - FOO) * String.new(encoding: 'FOO') @@ -1639,10 +1624,6 @@ rb_str_resurrect(VALUE str) * ascii = "Que veut dire \u{e7}a?".force_encoding('ASCII') * # Raises Encoding::CompatibilityError (incompatible character encodings: UTF-8 and US-ASCII) * utf8.include? ascii - * - * Raises an exception if +capacity+ is not \Integer-convertible: - * # Raises TypeError (no implicit conversion of Symbol into Integer): - * String.new(capacity: :foo) */ static VALUE |